Orchard to Orchard Core migraton

[johnmangam]

Hi,

Could anyone share any documentation that is helpful to migrate from Orchard to Orchard Core?

Thank you.

[Skrypt]

There is no automated migration path because the DAL are quite different. Advertised way is to either use the Import/Export feature in Orchard Core that works with formatted JSON data or to use the ContentManager class and methods.

[johnmangam]

@Skrypt Thank you! Is there any webpage with at least high-level guidelines for this process?

[kevinsmgov]

While the Orchard Core version of a given custom module is philosophically similar to it's original Orchard counterpart, you still need to write it from scratch (depending on the logic, you can copy and paste some source code across but assume that most OrchardCore classes and methods have been renamed to some extent - e.g. from Orchard... to OrchardCore...)

The bigger challenge I found was migrating the data.

Using Orchard's command line utility, I created a series of export commands to create the Orchard Core compatible JSON import/export package files. For instance, below is the command to export my Orchard menus into an Orchard Core compatible menu import package.

I created a separate command for each of my custom content types so that I could rerun them individually as I was prototyping the Orchard Core versions of their corresponding modules.

    public class CoreExportCommand : DefaultOrchardCommandHandler {
        private readonly IOrchardServices _orchardServices;
        public CoreExportCommand(IOrchardServices orchardServices) {
            _orchardServices = orchardServices;
        }
        [CommandName("core export menus")]
        [CommandHelp(@"core export menus
        export menus for orchard core")]
        public void CoreExportMenu() {
            var menus = _orchardServices.ContentManager.Query("Menu").List().ToList();
            var menuItems = _orchardServices.ContentManager.Query("MenuItem").List().ToList();
            dynamic export = new JObject();
            export.name = "";
            export.displayName = "";
            export.description = "";
            export.author = "";
            export.website = "";
            export.version = "";
            export.issetuprecipe = false;
            export.categories = new JArray();
            export.tags = new JArray();
            export.steps = new JArray();
            var data = new JArray();
            foreach (var menu in menus) {
                CommonPart commonPart = menu.Parts.Single(part => part.PartDefinition.Name == "CommonPart") as CommonPart;
                IdentityPart identityPart = menu.Parts.Single(part => part.PartDefinition.Name == "IdentityPart") as IdentityPart;
                TitlePart titlePart = menu.Parts.Single(part => part.PartDefinition.Name == "TitlePart") as TitlePart;
                // only export these menus
                if (titlePart.Title == "Header Menu" || titlePart.Title == "Footer One" || titlePart.Title == "Footer Two") {
                    var title = titlePart.Title;
                    // rename header menu to main menu
                    if (title == "Header Menu") {
                        title = "Main Menu";
                    }
                    var thisItem = new JObject(
                        new JProperty("ContentItemId", CoreIDs.GenerateCoreId(new Guid(identityPart.Identifier))),
                        new JProperty("ContentType", "Menu"),
                        new JProperty("DisplayText", title),
                        new JProperty("Latest", true),
                        new JProperty("Published", true),
                        new JProperty("ModifiedUtc", commonPart.ModifiedUtc.Value.ToString("yyyy-MM-ddTHH:mm:ssZ")),
                        new JProperty("PublishedUtc", commonPart.PublishedUtc.Value.ToString("yyyy-MM-ddTHH:mm:ssZ")),
                        new JProperty("CreatedUtc", commonPart.CreatedUtc.Value.ToString("yyyy-MM-ddTHH:mm:ssZ")),
                        new JProperty("Owner", "admin"),
                        new JProperty("Author", "admin"),
                        new JProperty("TitlePart", new JObject(
                            new JProperty("Title", title)
                            )),
                        new JProperty("AliasPart", new JObject(
                            new JProperty("Alias", title.Replace(" ", "-").ToLower())
                            )),
                        new JProperty("MenuPart", new JObject())
                        );
                    MenuItems(thisItem, menu, menuItems);
                    data.Add(thisItem);
                }
            }
            var step = new JObject(
                new JProperty("name", "content"),
                new JProperty("data", data));
            export.steps.Add(step);
            //Console.Write(export.ToString());
            CreatePackage(@"c:\temp\Menus.zip", export);
        }
        void MenuItems(JObject data, ContentItem parentMenu, List<ContentItem> menuItems) {
            var childMenuItems = menuItems.Where(item => item.Content.MenuPart.Menu.Id == parentMenu.Id);
            if (childMenuItems.Count() > 0) {
                ChildMenuItems("", data, childMenuItems);
            }
        }
        void ChildMenuItems(String prefix, JObject data, IEnumerable<ContentItem> availableMenuItems, int level = 0) {
            level++;
            var thisArray = new JArray();
            for (var index = 1; true; index++) {
                var menuPosition = String.Format("{0}{1}", prefix, index);
                var menuItem = availableMenuItems.FirstOrDefault(item => item.Content.MenuPart.MenuPosition == menuPosition);
                if (menuItem != null) {
                    dynamic thisItem = new JObject(
                        new JProperty("ContentItemId", CoreIDs.GenerateCoreId(menuItem.Content.IdentityPart.Identifier as String)),
                        new JProperty("ContentType", "LinkMenuItem"),
                        new JProperty("DisplayText", menuItem.Content.MenuPart.MenuText),
                        new JProperty("LinkMenuItemPart",
                            new JObject(
                                new JProperty("Name", menuItem.Content.MenuPart.MenuText),
                                new JProperty("Url", menuItem.Content.MenuItemPart.Url)
                                )
                            )
                        );
                    ChildMenuItems(String.Format("{0}.", menuPosition), thisItem, availableMenuItems, level);
                    thisArray.Add(thisItem);
                }
                else {
                    break;
                }
            }
            if (thisArray.Count > 0) {
                var menuItemsListPart = new JProperty("MenuItemsListPart", new JObject(new JProperty("MenuItems", thisArray)));
                data.Add(menuItemsListPart);
            }
        }

To package up the JSON that the command creates, I had this function:

        void CreatePackage(String path, dynamic export) {
            using (FileStream zipToOpen = new FileStream(path, FileMode.OpenOrCreate)) {
                using (ZipArchive archive = new ZipArchive(zipToOpen, ZipArchiveMode.Update)) {
                    ZipArchiveEntry recipe = archive.GetEntry("Recipe.json");
                    if (recipe != null)
                        recipe.Delete();
                    recipe = archive.CreateEntry("Recipe.json");
                    using (StreamWriter writer = new StreamWriter(recipe.Open())) {
                        writer.Write(export.ToString());
                    }
                }
            }
        }

In order to create ContentItemdIds for Orchard Core from the Guid based ids Orchard uses, I grabbed a copy of the code from the OrchardCore source that created those Ids and added that to my Orchard export command line utlity

    public static class CoreIDs {
        private static readonly string _encode32Chars = "0123456789abcdefghjkmnpqrstvwxyz";

        public static string GenerateCoreId(Guid value) {
            // Generate a base32 Guid value
            var guid = value.ToByteArray();

            var hs = BitConverter.ToInt64(guid, 0);
            var ls = BitConverter.ToInt64(guid, 8);

            return ToBase32(hs, ls);
        }
        public static string GenerateCoreId(String value) {
            // Generate a base32 Guid value
            var guid = new Guid(value).ToByteArray();

            var hs = BitConverter.ToInt64(guid, 0);
            var ls = BitConverter.ToInt64(guid, 8);

            return ToBase32(hs, ls);
        }

        private static string ToBase32(long hs, long ls) {
            var charBuffer = new char[26];

            charBuffer[0] = _encode32Chars[(int)(hs >> 60) & 31];
            charBuffer[1] = _encode32Chars[(int)(hs >> 55) & 31];
            charBuffer[2] = _encode32Chars[(int)(hs >> 50) & 31];
            charBuffer[3] = _encode32Chars[(int)(hs >> 45) & 31];
            charBuffer[4] = _encode32Chars[(int)(hs >> 40) & 31];
            charBuffer[5] = _encode32Chars[(int)(hs >> 35) & 31];
            charBuffer[6] = _encode32Chars[(int)(hs >> 30) & 31];
            charBuffer[7] = _encode32Chars[(int)(hs >> 25) & 31];
            charBuffer[8] = _encode32Chars[(int)(hs >> 20) & 31];
            charBuffer[9] = _encode32Chars[(int)(hs >> 15) & 31];
            charBuffer[10] = _encode32Chars[(int)(hs >> 10) & 31];
            charBuffer[11] = _encode32Chars[(int)(hs >> 5) & 31];
            charBuffer[12] = _encode32Chars[(int)hs & 31];

            charBuffer[13] = _encode32Chars[(int)(ls >> 60) & 31];
            charBuffer[14] = _encode32Chars[(int)(ls >> 55) & 31];
            charBuffer[15] = _encode32Chars[(int)(ls >> 50) & 31];
            charBuffer[16] = _encode32Chars[(int)(ls >> 45) & 31];
            charBuffer[17] = _encode32Chars[(int)(ls >> 40) & 31];
            charBuffer[18] = _encode32Chars[(int)(ls >> 35) & 31];
            charBuffer[19] = _encode32Chars[(int)(ls >> 30) & 31];
            charBuffer[20] = _encode32Chars[(int)(ls >> 25) & 31];
            charBuffer[21] = _encode32Chars[(int)(ls >> 20) & 31];
            charBuffer[22] = _encode32Chars[(int)(ls >> 15) & 31];
            charBuffer[23] = _encode32Chars[(int)(ls >> 10) & 31];
            charBuffer[24] = _encode32Chars[(int)(ls >> 5) & 31];
            charBuffer[25] = _encode32Chars[(int)ls & 31];

            return new string(charBuffer);
        }
    }

[Piedone]

See our new guide on Orchard Dojo: https://orcharddojo.net/blog/how-to-migrate-an-orchard-1-application-to-orchard-core Also check out the Lombiq Helpful Extensions - Orchard 1 Recipe Migration feature.