Jump to content
adrian

Migrator

Recommended Posts

GitHub: https://github.com/adrianbj/ProcessMigrator


 


This module has gone through lots of iterations with lots of new functionality each time. It is now a fully fledged content migration tool.


 


*** Please be sure to read the GitHub ReadMe to find out what it can do now as most of the posts in this thread are no longer correct regarding its functionality


 


 


Once it is release worthy, I'll create a fresh thread with all the details.


 


 


This modules allows export, sharing, and import of page lists via JSON files.


 


It takes care of replicating all the pages, as well as creating any templates and fields that are needed.


 


I have defined "Page Lists" as page trees (parent and children) that store selector values for a Page fieldtype. An example would be a list of countries that would be used to populate a countries drop-down select field. The fields might include: Country Name, 2-digit code, 3-digit code, number code.


 


I would like to suggest a place where we can post json files to be shared and updated - maybe a dedicated github repository?


Start of a repo of lists ready to import is now available: https://github.com/adrianbj/ProcessWirePageLists


 


It might handle migrating other simple pages trees as well, but it should not be considered a tool for migrating general pages as it does not handle associated files, nor does it handle fields which store arrays. Probably lots of other things it doesn't handle either :)


 


It now handles migrating all (I think) field types, including repeater fields, page fields, all Profields fields, multi-language versions of fields etc. The only omission is the actual uploaded files and images in file/image fields.


 


WARNING: This should be considered an Alpha module - please don't use this on a live site at the moment and be sure to back everything up before testing.


 


 


Would appreciate any feedback on the concept, the code, and the idea of a shared and community edited resource of these files.


 


Also, would love to hear what page lists would be good to share. Here are a few quick ideas:


  • States (separate files for each country)
  • Measurement units
  • Languages
  • Religions
  • Race
  • Academic subjects (chemistry, biology etc)
  • Publication types (book, journal article, newspaper article, newsletter, thesis etc)
  • Car makes and models

Anyone have a better idea for a name, or how to better describe "Page Lists"?


Edited by Nico Knoll
Added the "module" tag.
  • Like 18

Share this post


Link to post
Share on other sites

Very interesting!

Does it create the fields also when importing (those are defined in JSON, so that made me assume)? I would also think about JSON schema - should metadata and content data be in their own containers? Something like "meta" and "data"?

Share this post


Link to post
Share on other sites

Yep,

It creates all required templates and fields using the settings from the original version. It won't re-create or modify a field if it is already existing, but it will add an existing field of that name to the required template.

I did think about separating the metadata and content - went with the lazy option to start with until I get some feedback on what changes to functionality might be good.

At the moment, the first item is the parent, parent template and child template info. The second is the field info. The rest are the data.

  • Like 1

Share this post


Link to post
Share on other sites

So theoretically I could have one parent and one child page with all my fields setup, export it, and and then use this to import a field setup?

Share this post


Link to post
Share on other sites

Interesting thought Marty - I hadn't considered that at all, but I don't see why not :)

Of course it would mean all the fields would initially be added to the template of that child page, but I guess no big deal.

I wonder whether it would be worth taking it beyond its original goal and give it the ability to export all levels of children, grandchildren, great grandchildren etc, so an entire site of pages, templates and fields could be migrated. Obviously there are lots of issues to make this work, and is not why I built this. If I tried for that functionality, it would still fall short of the Profile Exporter, because it wouldn't support copying of template and other files, but it might still be a useful tool.

  • Like 1

Share this post


Link to post
Share on other sites

My mind works in mysterious ways :) Not every site I build is the same, there are always subtle differences. For things like blogs and galleries being able to export a basic page heirarchy (& fieldset) and recreate it on a new site build would be a huge, huge time saver.

  • Like 4

Share this post


Link to post
Share on other sites

:) I agree I think this could be cool. The profile exporter is great if you want to copy an entire setup, but it would be great for example to be able to "install" the pages/templates/fields for an image gallery from an existing site onto a new site with a couple of clicks at any point in the development of the site (unlike the site exporter where it is the entire site and you need to do it at the start).

Perhaps I could also add an option to just export/import the page/template/ field structure without the data!

I'll have to experiment with this in the next few days.

Thanks for the feedback

  • Like 3

Share this post


Link to post
Share on other sites

Looks cool, thanks for your work here. We got this discussion already to export and import template/fields and I think Ryan said we could build something with json or yaml. I'm not sure anyone else has started something but this could be a start.

Just briefly looking at the code it looks good. I'm not sure I understand why you have functions inside a class method? I'm sure it works but seems odd.

Also I'm not sure you are aware you can get template and fields with their settings with $field->getArray() $template->getArray() that will return an array with the properties. This might can be used to store them, though not sure it would be of help.

wire("templates")->get("basic-page")->getArray();

Would give something like:

Array
(
    [useRoles] => 1
    [editRoles] => Array
        (
            [0] => 1006
            [1] => 1675
        )

    [addRoles] => Array
        (
            [0] => 1006
            [1] => 1675
        )

    [createRoles] => Array
        (
            [0] => 1006
            [1] => 1675
        )

    [childrenTemplatesID] => 0
    [sortfield] => 
    [noChildren] => 
    [noParents] => 
    [childTemplates] => Array
        (
        )

    [parentTemplates] => Array
        (
        )

    [allowPageNum] => 1
    [allowChangeUser] => 0
    [redirectLogin] => 0
    [urlSegments] => 1
    [https] => 0
    [slashUrls] => 1
    [altFilename] => 
    [guestSearchable] => 0
    [pageClass] => 
    [pageLabelField] => 
    [noGlobal] => 0
    [noMove] => 0
    [noTrash] => 0
    [noSettings] => 0
    [noChangeTemplate] => 0
    [noUnpublish] => 0
    [nameContentTab] => 0
    [noCacheGetVars] => 
    [noCachePostVars] => 
    [useCacheForUsers] => 0
    [cacheExpire] => 0
    [cacheExpirePages] => Array
        (
        )

    [label] => 
    [tags] => 
    [roles] => Array
        (
            [0] => 37
            [1] => 1006
            [2] => 1675
        )

)

Also this is possible

wire("templates")->get("basic-page")->fieldgroup->getArray();
wire("fields")->get("body")->getArray();

Not sure how about template context settings. Anyway it would be a lot more work if you want to cover all settings.

  • Like 1

Share this post


Link to post
Share on other sites

Hey Soma,

Thanks for all the input. I have seen some discussion about export/import and I understand the challenges. I have also had a look through Antti's ProcessDataImport module. When I put this together I really wanted it to just handle simple page lists, so I wasn't planning on worrying about all the context settings and other issues that are a more challenging prospect.

Thanks for spotting the functions inside the method - this really was a quick and dirty initial effort designed to quickly copy some page lists to a new site I am working on. I'll make a note to reorganize those.

I remember seeing getArray in the cheatsheet some time ago, but didn't think about it for this use case at all. Could be very handy in making this module more capable - thank you! Seems like the only superfluous information are the roles settings - might be easiest to remove these from the array before json_encode'ing.

I guess I am trying to figure out how far to take this:

  1. It seems like it should be quite easy using getArray to grab most of the settings and iterate through them to set them on the new site. Are all of those settable via the API? - noGlobal etc?

    I think I should add support for all levels of children, grandchildren etc. 

    Plus an option to export/import structure (templates and fields and category pages) only - ie don't migrate the lowest level child pages - using a gallery example:

    Gallery
    --Nature
    ----Image 1
    ----Image 2
    --People
    --Kids

    It would migrate all the templates and fields for "Gallery" and all levels of nested pages, but it wouldn't migrate the Image pages themselves if "structure only" setting was checked.

     I think those enhancements would facilitate Marty's thoughts for migrating and setting up a full page hierarchy with templates and fields for a gallery etc.  
     
  2. Or perhaps it wouldn't be a big deal to also download any template files as well and include those in a zip along with the JSON file. The catch there might be permissions issues on the templates folder as this won't be writeable by default on most setups. Copying files from assets/files should be easy enough, but could result in a huge download package and also it might become interesting trying to reconnect these files to their appropriate new pages_id

I think for now at least, I'll aim for option 1. It seems like option 2 is something best tackled by Ryan as I am sure there are some big picture considerations that I'll miss at the moment. It would also become difficult deciding where to stop. For example I don't think a module like this should ever tackle migrating template access roles - I think it would be logical that these sorts of setting would be best redefined on the new site.  

Marty - can you think of anything I am overlooking in Option 1 for making this work for your idea?

Share this post


Link to post
Share on other sites

I have started a GitHub repo for Page Tree List JSON files: https://github.com/adrianbj/ProcessWirePageLists

I will add new ones as the need arises for me.

Still not sure if this is the best place for these. I am tempted to set up a simple site to house them that hooks into the Github API like the PW modules page.

Will see once I get an idea if people will actually use these or not. Might be more useful once I have taken care of some of the ideas in the above post.

Share this post


Link to post
Share on other sites

Thought I'd step in and show support for this - love the idea as a whole and Marty's hit upon an interesting use case there right away for easily setting up small sections of repetitive content that is a bit more modular perhaps than a site profile and useful when such things are outside the scope of a module themselves.

@Soma - I need to pay more attention to the cheatsheet as I'd not seen getArray() - would've been incredibly useful when I was debugging something the other day and print()'ing a page object... which causes a mess on the screen :D

  • Like 2

Share this post


Link to post
Share on other sites

Adrian I don't really have any more thoughts to add. A structure-only option sounds great. I can see this module being used in conjunction with the ImportPagesCSV and Wanze's Batcher a fair bit.

Cheers

Marty

Share this post


Link to post
Share on other sites

Thanks Marty,

I just added the structure only option and pushed to Github. At the moment it still creates the parent page, but not the child pages.  I am hoping to spend some time now looking into importing all levels of children which will be needed in some use cases, so I think I will need to change the structure behaviour to have three options - 1) all pages, 2) no pages at all, and 3) all levels of pages, except the very lowest level child pages so that categories and other levels are be created if wanted, without population of the actual content pages. Hope that makes sense.

I guess it will be an experiment to see what I think will be most useful / versatile for people.

  • Like 1

Share this post


Link to post
Share on other sites

Perhaps it's my PW version (2.3) but all I get in the json.json file is [ ]. What's does Save &/or Copy do?

Share this post


Link to post
Share on other sites

Hey Marty - sorry for the confusion. You need to choose one of those options - obviously I need to come up with a better name. 

Save will spawn a download of the JSON file. Copy will output it on the screen so you can copy it.

I assume you have chosen a Parent page and structure option as well? I thought I had made them all required fields, but maybe not - will check.

I am getting close to having multiple levels of children etc working too - getting exciting :)

Share this post


Link to post
Share on other sites

Yeah I followed the steps. I chose a top level page with a few children then Structure only and Save. I tried all options actually and I only got an empty file.

Exciting is an understatement... :)

Share this post


Link to post
Share on other sites

Weird!

Would you mind trying to import that countries.json file for me and see if that works. If it does, could you then try to export that countries page tree and see if that works. 

I am running a fairly recent dev version, but I don't think I am using anything particularly new.

Sorry you are the guinea pig on this :)

Share this post


Link to post
Share on other sites

I imported the US States json file perfectly. I just can't seem to export. Perhaps it's my server setup. I'll give it a go locally at some point.

Share this post


Link to post
Share on other sites

Thanks Marty - strange the export is not working for you. Would definitely love to hear how it goes locally for you. Also could you give me a rundown of your server setup?

Do you have debug on? Any php errors?

I should be finished with the next round of functionality tomorrow - changing quite a few things, so we'll see if that helps as well. 

If not, hopefully someone else can confirm whether it is working for them or not and we can go from there.

Share this post


Link to post
Share on other sites

OK, I have a new version ready, with a new name: Page Tree Migrator

This new version has a new Github page: https://github.com/adrianbj/ProcessPageTreeMigrator

It can still handle simple "page list" imports and I have update the format of the countries.json and us-states.json files at: https://github.com/adrianbj/ProcessWirePageLists

WARNING: It should still be considered alpha at the moment, so please be careful !!

You will now need this new module to be able to import those files.

Whats' New

  1. Ability to import any page tree with infinite levels of children
  2. Templates are now created with all (I think?) settings from the original setup (including Family child and parent templates allowed).
  3. Three export options: 
        - Everything, including all data pages
        - Field, templates, and structural pages
        - Fields and templates only

    I am not really happy with the middle one yet (see Road Map for more details), but I think the other two are very useful.

Road Map

  1. Testing - It has been working great for me so far, but I am sure you guys will find some problems - I know it is far from perfect :)
  2. Code cleanup - at minimum I want to rename some variables etc to be more logical and add some detailed commenting. I am sure someone with more PW experience will see a mess in how I have achieved certain things. I know of a few things already that I want to redo, but for now I just want to get it out for testing :)
  3. Add more options for the "Field, templates, and structural pages" export option. At the moment this exports the templates, fields, and all pages, except for the final child level. My logic was geared towards something like a gallery with this structure:

    Gallery
    --Nature
    ----Image 1
    ----Image 2
    --People
    --Animals

    So, with this export option, you would only export the Gallery parent page, and the category pages (nature, people, animals). The image grandchildren won't be exported so you can use this to start with a clean gallery page tree.

    However, I think I should add more options that allow the user to select which levels of children to export and even which fields within these pages. That way you could choose to only export the title field for an entire set of pages, leaving the rest of the fields empty. Not sure of the most useful approach here. Any thoughts?
  4. Deal with any potential issues that occur when importing over an existing template if existing settings are different.
  5. What else do you guys want to see?
  • Like 2

Share this post


Link to post
Share on other sites

Just made a couple of quick updates on Github to v0.0.3 now to fix some path issues for the main parent in some situations. Hopefully fixed now, but we'll see :)

Off to sleep now - probably some more bug finding tomorrow :)

EDIT: Marty - let me know if this version works for you. 

Share this post


Link to post
Share on other sites

This looks even better. Import doesn't seem to work on my test site though, seems to some incompatibility with multilang features. This comes after using paste import:

Catchable fatal error: Object of class stdClass could not be converted to string in /srv/www/pw/frontendedit/wire/modules/LanguageSupport/FieldtypeTextLanguage.module on line 38

I am running PW 2.3.0 on that site.

Share this post


Link to post
Share on other sites

Thanks for finding that Antti, although I am having trouble reproducing it. Unfortunately I am pretty ignorant of the multilang features - typical English speaker I'm afraid :)

I just installed the Language Support (Core) module and ran a successful import without any errors.

I am running a fairly recent dev version so I wonder if that is the difference? Or maybe I actually need to install a language pack and set up an alternate language field to trigger the error. I'll keep investigating, but do you have any ideas?

BTW, I just fixed a problem with the country and state list files - my subconscious must have realized and woke me up (it's early here) - I should learn never to release code late at night :) This change won't be causing your error though.

Share this post


Link to post
Share on other sites

Tested it little bit more - it probably has something to do with the data structure I am trying to import:

{
    "pages": [
        {
            "name": "basicpage",
            "parent_name": "",
            "page_template": "basic-page",
            "status": 1,
            "sort": 7,
            "data": {
                "title": {
                    "data": "basicpage",
                    "data1029": "basicpage"
                },
                "headline": "",
                "summary": "",
                "body": {
                    "data": "",
                    "data1029": ""
                },
                "sidebar": "",
                "images": [],
                "related": [],
                "repeater": {
                    "data": "",
                    "count": 0,
                    "parent_id": 1052
                },
                "commentsSpecial": [
                    {
                        "id": 74,
                        "status": 1,
                        "data": "Hi there!",
                        "cite": "Antsa",
                        "email": "xxxx.xxxxx@xxxxxx.com",
                        "created": 1370721469,
                        "created_users_id": 41,
                        "ip": "91.156.11.190",
                        "user_agent": "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/27.0.1453.110 Safari/537.36",
                        "website": ""
                    }
                ],
                "thumbnail": []
            }
        },
        {
            "name": "templates",
            "parent_name": "basicpage/",
            "page_template": "basic-page",
            "status": 1,
            "sort": 0,
            "data": {
                "title": {
                    "data": "",
                    "data1029": ""
                },
                "headline": "",
                "summary": "",
                "body": {
                    "data": "",
                    "data1029": ""
                },
                "sidebar": "",
                "images": [],
                "related": [],
                "repeater": {
                    "data": "",
                    "count": 0,
                    "parent_id": 1059
                },
                "commentsSpecial": [],
                "thumbnail": []
            }
        }
    ],
    "templates": [
        {
            "template": "basic-page",
            "data": {
                "useRoles": 0,
                "childrenTemplatesID": 0,
                "sortfield": "",
                "noChildren": "",
                "noParents": "",
                "childTemplates": [],
                "parentTemplates": [],
                "allowPageNum": 0,
                "allowChangeUser": 0,
                "redirectLogin": 0,
                "urlSegments": 0,
                "https": 0,
                "slashUrls": 1,
                "altFilename": "",
                "guestSearchable": 0,
                "pageClass": "",
                "pageLabelField": "",
                "noGlobal": 0,
                "noMove": 0,
                "noTrash": 0,
                "noSettings": 0,
                "noChangeTemplate": 0,
                "noUnpublish": 0,
                "nameContentTab": 0,
                "noCacheGetVars": "",
                "noCachePostVars": "",
                "useCacheForUsers": 0,
                "cacheExpire": 0,
                "cacheExpirePages": [],
                "label": "",
                "tags": ""
            }
        }
    ],
    "fields": [
        {
            "name": "title",
            "label": "Title",
            "description": null,
            "template": "basic-page",
            "flags": 13,
            "type": "FieldtypePageTitleLanguage"
        },
        {
            "name": "headline",
            "label": "Headline",
            "description": "Use this instead of the Title if a longer headline is needed than what you want to appear in navigation.",
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeText"
        },
        {
            "name": "summary",
            "label": "Summary",
            "description": null,
            "template": "basic-page",
            "flags": 1,
            "type": "FieldtypeTextarea"
        },
        {
            "name": "body",
            "label": "Body",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeTextareaLanguage"
        },
        {
            "name": "sidebar",
            "label": "Sidebar",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeTextarea"
        },
        {
            "name": "images",
            "label": "Images",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeImage"
        },
        {
            "name": "related",
            "label": "Related pages",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypePage"
        },
        {
            "name": "repeater",
            "label": "Repeater",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeRepeater"
        },
        {
            "name": "commentsSpecial",
            "label": "Comments",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeComments"
        },
        {
            "name": "thumbnail",
            "label": "Image",
            "description": null,
            "template": "basic-page",
            "flags": 0,
            "type": "FieldtypeImage"
        }
    ]
}

If I export/import structure only, it works great!

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
    • By Mike Rockett
      TextformatterTypographer
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
    • By robert
      I often had the need for an overview of all used fields and their contents for a specific page/template while developing new websites without switching to the backend, so I made a small module which lists all the needed information in a readable manner (at least for me):
      Debug Page Fields
      https://github.com/robertweiss/ProcessDebugPageFields
      It adds two new properties to all pages:
      $page->debugFieldValues – returns an object with all (sub-)fields, their labels, fieldtypes and values $page->debugFieldTypes – returns an object with all fieldtypes and their corresponding fields // List all values of a pages $page->debugFieldValues // List a specific field $page->debugFieldValues->fieldname // List all used fieldtypes of a page $page->debugFieldTypes I recommend using it in combination with Tracy Debugger, Ray, Xdebug etc. as it returns an object and is only meant for developing/debugging uses. 
      For now, the fieldtype support includes mostly fieldtypes I use in my projects, but can easily be extended by adding a new FieldtypeFIELDNAME method to the module. I use it with five different client installations (all PW 3.0.*), but of course there might be some (or more) field configurations which are not covered correctly yet.
      Supported fieldtypes
      Button Checkbox Color Combo Datetime Email FieldsetPage * File FontIconPicker Functional Image ImageReference MapMarker Multiplier Mystique Options Page PageIDs PageTitle Radio Repeater * RepeaterMatrix * RockAwesome SeoMaestro Table Text Textarea Textareas Toggle URL * The fields with complete subfield-support also list their corresponding subfields.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. As this is my first ›public‹ module, I hope I did not miss any important things to mention here.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.6.0
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Cybermano
      Food Allergens Module
      A simple List of Food Allergens
      My needs were to provide a simple list of food allergens for our clients with restaurant related activity.
      The idea was to simply output the list (to speed up the data entry) without leaving the food menu editing, eg. opening another page in new tab or window.
      This isn't a perfect solution, but it works fine for my needs and I decided to share the base idea.
      This could also be easily used to show little notes or short "vademecum", not only for the list of food allergens.
      ---
      Main features
      The basis
      All moves from a short editing of the module in this tutorial: How to create custom admin pages by @bernhard
      First of all it creates an empty admin page, with a dedicated permission to let safe-user to see it (this permission has to be created as a new ones, manually or by the module).
      Once the page is created, I have hooked its behaviour into the ready.php, to show the content (basically a list).
      A step further
      With the tips of  @bernhard, @Soma (and many others), see here , the magic happens. 
      The new page will be shown as a panel, so editors will not abandon their data entry to have a quick view to the list.
      A little further
      Why scroll to the top of the page to click a link?
      The next step was to create a sticky button only in the food menu pages.
      Again with a @bernhard tip I moved into the customization of this simple module and the related hook.
      ---
      How to use this module
      After installed, it creates the page /admin/page/allergens/ and the module is to be setted up. The first field is a CKEditor with multi-language. This is the place where to write the informations that will be shown into the page. The next field is a simply text-area where to place a bit of JS that will be appended to the markup of the text (omit the 'script' tags). I also putted a checkbox with a silly statement: this to think at least twice on the safety of the written JS. Now comes the first way to display the link to the page
      Field Note with Link. Enable and save it. The module will display a new row with 4 selects (1 standard and 3 ASM):
      View mode (to show the page as Panel or as Modal PopUp); Templates to select: select one or more and save before proceed, so the  asm-select of the pages will be populated showing all the pages of the selected templates. Pages to select: also here select at least one and save before proceed to populate the asm-select for fields only with the ones that belong to the selected pages. Select the fields where to place the note and save again. That's all: now you will find into the notes of the selected fields the link "See the List of Allergens".
      At the same way, the option for the sticky button, but with a plus
      The field select is obviously unnecessary, but you could play with the last row: the inline styles to fix your sticky button where you like. Here you could set the sticky position of the <div> and the absolute ones of the <a>.

      Video Explanation
      In these screencasts you could see a custom JS that show a "copy" button near a "hanna-code" call.
      This because I've set a specific one for each allergen to show up a tooltip in the front end.

      Registrazione #33.mp4  

      Registrazione #34.mp4 ---
      Last but not the least
      Actually it works fine for my needs, even if it's much improvable: I'm working on the permissions creation, the uninstall section, a separate configs and defaults and how to include the hook into the module leaving free the ready.php. According to a simpler uninstall. Also I would make the link text as a dynamic text field, so it will be more flexible.
      I always learn a lot here, so I would share my code for whom it could be interested.
      I removed the hanna code references, but I provide you the html list of the allergens, English and Italian too, so you can paste them into the "source" of the CKEditor field to have a ready to use module.
      Obviously you are free to modify the code as per your needs.
      Please, keep in mind that I'm not a pro coder and I beg your pardon for my verbosity (speaking and coding). 😉
      I hope be helpful or for inspiration.
      Bye
      ready.phpList-ITA.htmlList-ENG.htmlAllergens.module
      README.md
×
×
  • Create New...