Import Site Columns
In my last post I wrote about a command that I created to export site columns to an xml file because I needed the data for a Feature I was working on. But what if you just want to create a column using the exported results and for whatever reason you don't want to create a Feature? I figured it would take me about 2 minutes to throw together an import command that would take in the results of the export so may as well add it to the collection. So now you can use the gl-importsitecolumns command to import what you exported using gl-exportsitecolumns (useful if you're just trying to move some fields around though I'd still recommend you do this via a Feature). Note that this command will blow up if a column already exists with the same name. The code for this is really simple - just loop through the XML and call the SPFieldCollection's AddFieldAsXml method:
1: string url = Params["url"].Value;
2:
3: XmlDocument xmlDoc = new XmlDocument();
4: xmlDoc.Load(Params["inputfile"].Value);
5:
6:
7: // Get the source content type and fields.
8: using (SPSite site = new SPSite(url))
9: using (SPWeb web = site.AllWebs[Utilities.GetServerRelUrlFromFullUrl(url)])
10: {
11: foreach (XmlElement fieldNode in xmlDoc.SelectNodes("//Field"))
12: {
13: web.Fields.AddFieldAsXml(fieldNode.OuterXml);
14: }
15: }
C:\>stsadm -help gl-importsitecolumns
stsadm -o gl-importsitecolumns
Imports one or more site fields (columns) to a site.
Parameters:
-url <url>
-inputfile <file to import fields from>
Here's an example of how to import site columns that were exported using the exportsitecolumns command:
Export Site Columns
As I mentioned in my previous post about the gl-exportcontenttypes command I need to be able to quickly and easily get the CAML necessary to recreate site columns in a Feature. To do this I created a quick and dirty command called gl-exportsitecolumns. The code for this is extremely simple - I just get the SPField objects of interest based on the parameters passed in and dump out the SchemaXml property - that's it:
1: string url = Params["url"].Value;
2: string fieldTitle = Params["fielddisplayname"].Value;
3: string fieldName = Params["fieldinternalname"].Value;
4: string groupName = Params["group"].Value;
5: bool useTitle = Params["fielddisplayname"].UserTypedIn;
6: bool useName = Params["fieldinternalname"].UserTypedIn;
7: bool useGroup = Params["group"].UserTypedIn;
8: bool all = !(useTitle || useName || useGroup);
9:
10: StringBuilder sb = new StringBuilder();
11: XmlTextWriter xmlWriter = new XmlTextWriter(new StringWriter(sb));
12: xmlWriter.Formatting = Formatting.Indented;
13:
14: try
15: {
16: xmlWriter.WriteStartElement("Elements");
17:
18: // Get the source content type and fields.
19: using (SPSite site = new SPSite(url))
20: {
21: using (SPWeb web = site.AllWebs[Utilities.GetServerRelUrlFromFullUrl(url)])
22: {
23: SPFieldCollection fields = web.Fields;
24: foreach (SPField field in fields)
25: {
26: if (all ||
27: (useGroup && groupName.ToLowerInvariant() == field.Group.ToLowerInvariant()) ||
28: (useName && fieldName.ToLowerInvariant() == field.InternalName.ToLowerInvariant()) ||
29: (useTitle && fieldTitle.ToLowerInvariant() == field.Title.ToLowerInvariant()))
30: {
31: xmlWriter.WriteString("\r\n");
32: xmlWriter.WriteRaw(field.SchemaXml);
33: }
34: }
35: }
36: }
37:
38: xmlWriter.WriteString("\r\n");
39: xmlWriter.WriteEndElement(); // Elements
40: }
41: finally
42: {
43: xmlWriter.Flush();
44: xmlWriter.Close();
45: }
46: File.WriteAllText(Params["outputfile"].Value, sb.ToString());
C:\>stsadm -help gl-exportsitecolumns
stsadm -o gl-exportsitecolumns
Exports one or more site fields (columns) to a file.
Parameters:
-url <url>
{[-fielddisplayname <field display name> / -fieldinternalname <field internal name>]
[-group <site column group name to filter results by>]}
-outputfile <file to output field schema to>
Here's an example of how to dump the XML for all the site columns in a particular group:
Apply Upgrade Area Url Mappings
As I mentioned in my previous post (Replace Field Values) I'm currently trying to solve the issue of broken links throughout the various sites that I've upgraded and moved around. The gl-replacefieldvalues command was the first of three that I've created. This second command, called gl-applyupgradeareaurlmappings, is very similar to the gl-replacefieldvalues command but it is a bit specialized.
I've created this command to address the list items in the special Upgrade Area Url Mappings list (http://[portal]/Lists/98d3057cd9024c27b2007643c1/AllItems.aspx). Instead of taking in a search string and replace string like the other command does I use this list as the source for the search and replace string. The intent is to prevent the user from having to deal with the spsredirect.aspx page when clicking links within a web application.
It's important to note though that I've limited this command to be scoped at the web application level and below and the upgrade list must exist in the web application being targeted. I went back and forth on whether I wanted to allow a farm scope but in the end decided against it. I also considered allowing you to target one application but reference the list from another but the reality of that was that it would be much too difficult to do a reliable replace due to the fact that the URLs in the list are server relative so I simply wouldn't be able to know which to make absolute and which web app to use for the absolute path.
I haven't been able to do a significant amount of testing with this but it seems to work fairly well - I was concerned about the order in which the replacements occur which could result in funny things happening but in the test runs that I did the replacements seemed to work just fine (if anyone finds differently please let me know and I'll see if I can work it out).
Because of this and due to the general nature of making batch content replacements I strongly suggest using the "-test" parameter and verifying all the changes that will be attempted before you execute for real - if you don't and things get messed up then you'll have a nice new command to create: "revertpreviouscheckins" sounds like a good name 
The large bulk of this code is just a series of methods with different loops in them to handle the various scoping capabilities. The core code itself is simply looking at all fields of type string and doing a regular expression replace using the information from the upgrade list. Like the gl-replacefieldvalues command I've added the ability to dump all changes to a log file as well as to run the command in a "test" mode where it will show you what it would change but not actually make the change (as mentioned above) - Again, I'd strongly recommend you use this first to verify all the changes that will be made. The core code is shown below:
1: /// <summary>
2: /// Replaces the values.
3: /// </summary>
4: /// <param name="list">The list.</param>
5: /// <param name="settings">The settings.</param>
6: private static void ReplaceValues(SPList list, Settings settings)
7: {
8: if (list.Title.ToLowerInvariant() == "upgrade area url mapping" || list.DefaultViewUrl.ToLowerInvariant().IndexOf(UPGRADE_AREA_URL_LIST) >= 0)
9: return; // We don't want to process this list as it's the source of our data.
10:
11: Log(settings, "Processing List: " + list.DefaultViewUrl);
12:
13: if (upgradeUrls == null)
14: {
15: BuildReplacementUrlsList(settings);
16: }
17:
18: // We've got the replacement list built - now we need to check every field of every item.
19: foreach (SPListItem item in list.Items)
20: {
21: if (item.File != null && !Utilities.IsCheckedOutByCurrentUser(item))
22: {
23: continue;
24: }
25: bool wasCheckedOut = true;
26: bool modified = false;
27:
28: foreach (SPField field in list.Fields)
29: {
30: if (item[field.Id] == null || field.ReadOnlyField)
31: continue;
32:
33: Type fieldType = item[field.Id].GetType();
34:
35: if (fieldType != typeof(string))
36: continue; // We're only going to work with strings.
37:
38: string fieldName = field.Title.ToLowerInvariant();
39: if (settings.UseInternalFieldName)
40: fieldName = field.InternalName.ToLowerInvariant();
41:
42: if (settings.FieldName == null || settings.FieldName.ToLowerInvariant() == fieldName)
43: {
44: // if (item[field.Id].ToString().IndexOf("C4/") >= 0)
45: // System.Diagnostics.Debugger.Break();
46:
47: // We've found a field that we need to consider. Check all possibilities to see if a match is found.
48: foreach (ReplacmentSettings rs in upgradeUrls)
49: {
50: bool isMatch = rs.Regex.IsMatch((string)item[field.Id]);
51:
52: // if (item[field.Id].ToString().IndexOf("C4/") >= 0 && rs.Regex.ToString().IndexOf("C4/") >= 0)
53: // System.Diagnostics.Debugger.Break();
54:
55: if (!isMatch)
56: continue;
57:
58: string result = rs.Regex.Replace((string)item[field.Id], rs.ReplaceString);
59:
60: Log(settings,
61: string.Format("Match found: List={0}, Field={1}, Replacement={2} => {3}", item.Url,
62: field.Title, item[field.Id], result));
63:
64: if (!settings.Test)
65: {
66: if (item.File != null && item.File.CheckOutStatus == SPFile.SPCheckOutStatus.None)
67: {
68: item.File.CheckOut();
69: wasCheckedOut = false;
70: }
71: item[field.Id] = result;
72: modified = true;
73: }
74: }
75: }
76: }
77: if (modified && !settings.Test)
78: item.Update();
79:
80: if (modified && item.File != null)
81: item.File.CheckIn("Checking in changes to list item due to automated upgrade area url mappings being applied.");
82: else if (!wasCheckedOut && item.File != null)
83: item.File.UndoCheckOut();
84:
85: if (modified && settings.Publish && !wasCheckedOut)
86: PublishItems.PublishListItem(item, list,
87: new PublishItems.Settings(settings.Quiet, settings.Test,
88: settings.LogFile),
89: "\"stsadm.exe -o replacefieldvalues\"");
90: }
91: Log(settings, "Finished Processing List: " + list.DefaultViewUrl + "\r\n");
92: }
93:
94: /// <summary>
95: /// Builds the replacement urls list.
96: /// </summary>
97: /// <param name="settings">The settings.</param>
98: private static void BuildReplacementUrlsList(Settings settings)
99: {
100: // We need to build a local copy of the replacement urls so that we don't have to keep referring back
101: // to the list for the information.
102: upgradeUrls = new List<ReplacmentSettings>();
103: foreach (SPListItem item in settings.UpgradeList.Items)
104: {
105: if ((bool)item["ShouldRedirect"])
106: {
107: ReplacmentSettings rs = new ReplacmentSettings();
108: rs.ReplaceString = (string)item["V3ServerRelativeUrl"];
109: string str = (string) item["V2ServerRelativeUrl"];
110:
111: rs.Regex = new Regex("(?i:" + str + "|" + SPEncode.UrlEncodeAsUrl(str) + ")");
112:
113: upgradeUrls.Add(rs);
114: }
115: }
116: }
C:\>stsadm -help gl-applyupgradeareaurlmappings
stsadm -o gl-applyupgradeareaurlmappings
Replaces all occurrences of the V2 server relative URLs with the corresponding V3 server relative URLs as specified in the Upgrade Area Url Mappings list: "http://[portal]/Lists/98d3057cd9024c27b2007643c1/AllItems.aspx"
Parameters:
-url <url to search>
-scope <WebApplication | Site | Web | List>
[-field <field name>]
[-useinternalfieldname (if not present then the display name will be used)]
[-quiet]
[-test]
[-logfile <log file>]
[-publish]
Here’s an example of how to replace all occurrences of the V2ServerRelativeUrls with the corresponding V3ServerRelativeUrl:
stsadm -o gl-applyupgradeareaurlmappings -url "http://intranet/" -scope webapplication -logfile "c:\replace.log" -publish
If you wish to filter by field name you can specify either the display name or the internal name. Note that if you specify the internal name you must also add the "useinternalfieldname" parameter - if you don't use the internal field name then be aware that you may be updating more than the field you intended as the display name is not always unique (but in most cases it is).
If you don't want your changes published then don't specify the publish parameter. However, specifying the publish parameter will not publish items that were previously checked out. If an item can be published and it requires approval then specifying the publish parameter will also cause the item to be approved.