Jump to content
teppo

Version Control

Recommended Posts

This module is improved and extended successor to Version Control For Text Fields. It handles everything it's predecessor did -- providing basic version control features for page content -- and quite a bit more. Download or clone from GitHub: https://github.com/teppokoivula/VersionControl.

This module requires ProcessWire 2.4.1 or later, mostly because of the file features, which require certain Pagefile and Pageimage methods to be hookable. There's no sensible way around this limitation; for those stuck with < 2.4.1, Version Control For Text Fields will remain a viable option.

What does it do?

While editing pages, fields with old revisions available show up with a new icon in their header bars. By hovering that icon you get a list of available revisions and by clicking any one of those the value of that particular field is reverted to that revision. No changes are made to page until you choose a revision and save the page, which means that you can keep switching between revisions to get an idea what's really changed without inadvertently causing any content to change.

The module also adds a History tab to page edit. This tab opens a view to the history of current page in the form of "revisions" -- each of which is a group of changes to page fields processed during one page save (similar to revisions in various source control applications). There are three actions you can perform on these revisions: adding comments, live previewing what the page might've looked in that revision and restoring the page to specific revision.

One specific feature that has been a big thing for me personally is support for file (and image) fields, as the original version control module felt rather incomplete without it. I'm hoping to take this a lot further performance, stability and feature wise, but as it stands right now, it's already included here and should be fully functional.

Watch the video preview here

I prepared a little screencast outlining most of this: http://youtu.be/AkEt3W7meic. Considering that it was my first screencast ever, I'd like to think that it wasn't that bad.. but I might give it another shot at some point, this time planning a bit before hitting "record"  :)

Upgrading from Version Control For Text Fields

For those already using Version Control For Text Fields, I've added something extra. If you upgrade that module to it's latest version, you should see a new checkbox in it's settings screen saying "Don't drop tables during uninstall". If you check this, uninstall the module and then remove it's files (this is required in order to install Version Control), your old data should be automagically imported to Version Control.

Import has only been tested with limited amounts of demo data. Proper tests are yet to come, so please be careful with this feature!

Update, 21.6.2015: as of today, this module is no longer in beta. While all the regular warnings still apply (making changes, including installing any new modules, on a production site should always be considered risky) Version Control has gone through pretty extensive testing, and should be as stable as any other module out there.

Edited by teppo
Added a note about not being a beta release anymore
  • Like 34
  • Thanks 2

Share this post


Link to post
Share on other sites

Very nice and I believe it will be a very useful tool.

  • Like 1

Share this post


Link to post
Share on other sites

Amazing module with impressive ease of use! And really slick and jaw dropping inline-page-version preview!

  • Like 1

Share this post


Link to post
Share on other sites

Huge release! Congratulations Teppo! I love the preview UI, very neat.

  • Like 2

Share this post


Link to post
Share on other sites

This is awesome Teppo!

Of course near the end it looks like many versions are created as adding images saves the page behind the scenes via Ajax so that's one way you'll end up with a lot of revisions (did I remember that correctly or make it up?). I'm wondering if it's worth making it so it only stores revisions when updating image and file fields AFTER the Save button is pressed? Or did you already take that into account?

Loving this module and it will be fascinating to see how you handled the image and file fields when I dig into the code :)

  • Like 3

Share this post


Link to post
Share on other sites

Thanks guys, really appreciate all the kind words! :)

@Pete: you're right, each AJAX upload creates new revision at the moment. This is difficult to circumvent without sacrificing reliability, but I'll give it some thought.

Since each asynchronous file upload creates separate POST request updating value of given field, it's actually logical that each of those would also create new revision. From technical point of view this is no different than doing something like "$page->title = 'foo'; $page->save('title');" via API, since the end result is exactly same; whether or not user actually realises it, page content changes instantly each time a file has been uploaded.

Anyway, I'll have to see if this could be somehow improved :)

Share this post


Link to post
Share on other sites

I don't see any other way for files really. Maybe bundling multiple (meaning no other changes in between and max few minutes time) additions or removes into same revision. That could be done in UI only.

Share this post


Link to post
Share on other sites

My thinking was simply checking if the input button has been clicked and only creating a revision if $this->input->post->submit_save is present.

Along similar lines, it would be great to have the option of not creating a version of any field until the page is published (no versions for an unpublished page).

Both of these are useful/desirable in some scenarios and not in others so I'm happy for them to be configurable options - as it is the module is already awesome :)

Share this post


Link to post
Share on other sites

@Pete: thanks for both suggestions. I'll have to see if I can find a way to add these without affecting current behaviour negatively and creating unwanted inconsistencies between API and GUI behaviour :)

This is getting slightly off-topic, but as I've been diving into various version and/or source control systems lately, I've started seeing them, first and foremost, as a way to keep track of what really happened, so that you can later review the full chain of events that led to current state and retrace your steps.

That's apparently not how everyone else feels, though. Even Pro Git, which I've been browsing every now and then for ideas as well as Git tips, has an entire chapter titled "Git Tools - Rewriting History", explaining how to alter (prettify, falsify, whatever you call it) local commit history.

I guess it's, in the end, all about finding the right balance between flexibility and consistency :)

Share this post


Link to post
Share on other sites
as a way to keep track of what really happened, so that you can later review the full chain of events that led to current state and retrace your steps.

I hope that you will be able to stay faithful to some type of reliable transactional based version control.  I believe it will play a big part in where and how applications built on this can be deployed.

Anyway, I have always been impressed with your version control module.  Good Luck.

Share this post


Link to post
Share on other sites

Wow! This looks really amazing. Appears that I'll be having lunch at my desk today and testing this out. :)

I really like @pete's suggestions, and @antti's idea of a time interval for bundling. 

Share this post


Link to post
Share on other sites
After a vanilla Processwire 2.4 install, I can't get Version Control module working fully...

Module compatibility is stated as Processwire 2.4 (current stable version).

After Version Control install, Page Snapshot dependancy is not installed and states it requires 2.4.1 minimum.

‘Preview revision’ on the ‘History’ tab gives:

'TemplateFile: Method Page::snapshot does not exist or is not callable in this context'

Upgrading to Processwire 2.4.4 (current dev) allows module and dependancies to install.

‘Preview revision’ on the ‘History’ tab gives:

'TemplateFile: SQLSTATE[HY093]: Invalid parameter number: number of bound variables does not match number of tokens'

and php error:

'Undefined variable: page_ids in site/modules/VersionControl/PageSnapshot.module on line 253'

Version Control 0.9.15 installed. 

Version Control history is enabled for basic-page template.

Any ideas? Have I missed something?

Share this post


Link to post
Share on other sites

@sid: sounds kind of like you could have an earlier version of Page Snapshot module installed. Could please you check that you're running version 1.1.18 of it?

I'm sorry for the confusion about supported ProcessWire version. Dev branch is really needed to run this module. My original post mentioned that the module requires "2.4.1 or later, i.e. current dev branch", but since modules directory doesn't allow submissions unless you define a version ranging from 2.0 to 2.4 as compatible.. well, I can see how that could happen.

Share this post


Link to post
Share on other sites

Thanks for the reply - I have:

Page Snapshot 1.1.18

Process Version Control 0.9.5

Version Control 0.9.15

All 3 PHP errors are:

Undefined variable: page_ids in site/modules/VersionControl/PageSnapshot.module on line 253

Undefined variable: page_ids in site/modules/VersionControl/PageSnapshot.module on line 261

array_merge(): Argument #2 is not an array in site/modules/VersionControl/PageSnapshot.module on line 261

all of which feed into the SQL query missing parameter error when the statement is executed on PageSnapshot.module line 263 I guess?

Share this post


Link to post
Share on other sites

Thanks! There was an issue in PageSnapshot.module preventing it from working properly unless FieldtypeRepeater was installed too.

I've just pushed fix for that to GitHub, so if you could fetch latest version and see if it works any better?

Share this post


Link to post
Share on other sites

Page Snapshot 1.1.19 fixes the problem for me - thank you very much

Share this post


Link to post
Share on other sites

Hi teppo, is there a way to get the changes from the api?

$page->currentVersion->typicalFunctions;

$page->previousVersion->typicalFunctions;

I’m looking at implementing a status notification system for a project and this would be handy. For this I would need to grab different fields or a specific one and check for differences using a hook.

Share this post


Link to post
Share on other sites

Sorry for the delayed answer, Pierre-Luc! Been busy with other stuff and this totally slipped my mind.
 
What you've described there wasn't really possible without direct SQL queries until just a few moments ago. I've just pushed to GitHub an update to VersionControl.module (0.10.0) that adds new $page->versionControlRevisions() method. This isn't properly tested yet, but something like this should work:

// current value of field 'headline'
echo "Headline for current revision: {$page->headline}<br />";

// value of field 'headline' in previous revision
$revisions = array_keys($page->versionControlRevisions(2));
$page->snapshot(null, $revisions[1]);
echo "Headline for previous revision: {$page->headline}<br />";

// return Page to it's original (current) state
$page->snapshot();
echo "Back to current revision: {$page->headline}<br />";

Since snapshot() returns Page object to given revision or point in time ($page->snapshot($time, $revision)) you'll want to make sure it's back to it's original state in case you're going to make changes and save the page -- otherwise the revision you fetched with snapshot will be returned from history once you save the page.
 
$page->versionControlRevisions() returns an array of revisions for current page and can optionally take one param, $limit, to fetch only that many revisions if more exist. It's return value is in the form of array([revision] => [timestamp]), i.e. array(4 => '2014-01-01 02:00:00', 3 => '2014-01-01 01:00:00') etc. so in order to get just the revision IDs out of that I'm using array_keys() in the example above.
 
You could probably also do something like this, if you want to make sure that Page doesn't get accidentally returned from history (this'll consume more memory, though):

$revisions = array_keys($page->versionControlRevisions(2));
$page->previousVersion = clone $page;
$page->previousVersion->snapshot(null, $revisions[1]);
echo "Headline for previous revision: {$page->previousVersion->headline}<br />";

Not sure if you're still working on this, but this kind of feature felt useful so I'm glad you brought it up.. :)

  • Like 6

Share this post


Link to post
Share on other sites

That’s pretty neat teppo! The feature will be implemented a bit further down the road on this project so it’s far from too late! I’ll let you know when I’ll start playing with it. Awesome, thanks again!

Share this post


Link to post
Share on other sites

ran into a snafu today, here's the setup and behavior:

- Page table field (called reviews)

when adding a review, the review would save but then the field itself wouldn't save so the related page wouldn't be added into the page table and there would be a 500 error;  tried uninstalling various modules, but in the end it came down to this one, when i removed the template from the selected list of templates, the field started saving again; i will try and provide more info, but the errors were not specific to anything other than setting output formatting as false for the the page table field before saving...

Share this post


Link to post
Share on other sites

I just unliked the first post just to like it again. silly.

Sorry Macrura, if that doesn't help with you problem :mellow:

Share this post


Link to post
Share on other sites

@Macrura: if I'm getting this right, you're just adding a page to a PageTable field, and when Version Control is installed, this fails with a 500 error (internal server error). The page (review) itself gets added and saved properly, apparently.

To be clear, which template did you remove from Version Control enabled templates -- the one used for reviews or the one containing the PageTable field? Also, is there anything added to the error logs of Apache or PW?

I was kind of assuming that this module would attempt to store values for the PageTable field itself, which could've easily resulted in an error (don't think that I ever tested that), but since it's not in the supported fields by default, that's unlikely. Unless you've manually added PageTable to the list of supported fields? :)

Any additional info would be helpful. I'll continue testing, but at the moment I'm kind of lost here, and haven't been able to reproduce this issue.

Edit: added PageTable to supported fieldtypes locally. Doesn't work (as expected), but doesn't seem to break anything either. Will continue debugging.

Edited by teppo

Share this post


Link to post
Share on other sites

@teppo - many thanks for replying and sorry for the vagueness of my bug report;

to clarify, yes, there is a page table field where the ajax saving of the field fails when the Version Control is enabled for this template; i only have 3 fields enabled for VC, which are all simple text and body fields.

I removed the template of the containing page from the VC preferences and that allowed the pt field to be saved.

there were errors in the error log (cleared it though), but I'm not sure if they would help, but if so i can re-enable the VC on this template to generate the error if that would help... this site is still in testing, not live, so it's no problem to do that; i can probably get to that later today...

Share this post


Link to post
Share on other sites

there were errors in the error log (cleared it though), but I'm not sure if they would help, but if so i can re-enable the VC on this template to generate the error if that would help... this site is still in testing, not live, so it's no problem to do that; i can probably get to that later today...

Thanks. That would be very helpful (probably), since right now I'm kind of out of ideas here. It's probably something simple, I'm just failing to see what it could be.

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 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
    • By Robin S
      This module is sort of an upgrade to my earlier ImageToMarkdown module, and might be useful to anyone working with Markdown in ProcessWire.
      Copy Markdown
      Adds icons to images and files that allow you to copy a Markdown string to the clipboard. When you click the icon a message at the top left of the screen notifies you that the copying has occurred.
      Screencast

      Note: in the screencast an EasyMDE inputfield is used to preview the Markdown. It's not required to use EasyMDE - an ordinary textarea field could be used.
      Usage: Images
      When you hover on an item in an Images field an asterisk icon appears on the thumbnail. Click the icon to copy an image Markdown string to clipboard. If the "Description" field is populated it is used as the alt text.
      You can also open the "Variations" modal for an image and click the asterisk icon to copy an image Markdown string for an individual variation.
      Usage: Files
      When you hover on an item in a Files field an asterisk icon appears next to the filename. Click the icon to copy a link Markdown string to the clipboard. If the "Description" field is populated it is used as the link text, otherwise the filename is used.
       
      https://github.com/Toutouwai/CopyMarkdown
      https://processwire.com/modules/copy-markdown/
    • By BitPoet
      I've realized that I've been jumping back and forth between the PW API docs and the source code for site modules far too much. The idea to hold all necessary documentation locally in one place has occurred to me before, but getting PHPDocumentor et al set up and running reliably (and producing readable output) as always been too much of a hassle. Today I was asked how I find the right hooks and their arguments, and that inspired me to finally get my backside down on the chair and whip something up, namely the
      Module Api Doc Viewer
      ProcessModuleApiDoc
      It lets you browse the inline documentation and public (optionally also protected) class/method/property information for all modules, core classes and template files in the ProcessWire instance. The documentation is generated on the fly, so you don't have to remember to update your docs whenever you update a module.
      The module is quite fresh, so expect some bugs there. Behind the scenes it uses PHP-Parser together with a custom class that extracts the information I needed, and the core TextformatterMarkdownExtra module for rendering the description part in the phpdoc style comments.
      This is not a replacement / competitor to the API Viewer included in the commercial ProDevTools package. There is quite some information included in the inline documentation that my module can't (and won't) parse, but which makes up parts of the official ProcessWire API docs.
      This, instead, is a kind of Swiss army knife to view PHPDoc style information and get a quick class or function reference.
      If you feel daring and want to give it a spin, or if you just want to read a bit more, visit the module's GitHub repository.
      This is the overview page under "Setup" -> "Module API Docs":

      And this is what the documentation for an individual class looks like:

      The core module documentation can of course be found online, but it didn't make sense not to include them.
      Let me know what you think!

    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By teppo
      Admin Restrict Branch Select is an add-on / companion module for Admin Restrict Branch. With this module enabled, you can manually select more than one branch parent per user via the branch_parent field, and users with more than one option selected will be able to switch between those while editing site content. Switching between branches is done via a select field injected at the top of the page tree.
      Note that users are still limited to one branch at a time: this module will not make it possible to view multiple branches at the same time.
      When the module is installed, it will automatically update the branch_parent field if deemed necessary, i.e. if it isn't yet configured to allow selecting multiple pages. You can make changes to the field later, if you want to restrict selectable options by template, use asmSelect instead of PageListSelectMultiple, etc. 
      This is an early beta release, so be sure to test carefully before enabling this module in production!
      https://processwire.com/modules/admin-restrict-branch-select/
      https://github.com/teppokoivula/AdminRestrictBranchSelect
×
×
  • Create New...