Jump to content
cosmicsafari

Abort module Uninstall on condition

Recommended Posts

Hi all,

I have a module which creates numerous fields, pages etc. I would like to disable the ability to uninstall the module if any of the generated pages have children, as a mistaken uninstall could really mess up any website which is using it.

Im curious about what is the best way to achieve this, currently I have some like:

 

    public function ___uninstall(){

        error_log('---- UNINSTALL!! ----');

        //check to see if any config pages have been added and abort uninstall if true
        //to avoid uninstalling and losing any work which has been done up to this point.

        if($this->canWeUninstall()) {
            //remove pages
            $this->deletePages($this->cPages->getPages());

            //remove templates and field groups
            $this->deleteTemplates($this->cTemplates->getTemplates());

            //remove repeaters
            $this->deleteRepeaters($this->cRepeaters->getRepeaters());

            //delete fields
            $this->deleteFields($this->cFields->getFields(), $this->cRepeaters->getRepeaters());
        } else {
            error_log('Uninstall aborted because config settings exist!');
            $this->error('Whoops! Module cant be uninstalled as it appears to be in use.');
            return;
        }
    }

This works in the sense that it doesn't remove any of the generated content, which is good as it wont break the website. However it still shows the module as uninstalled,  I can achieve what i'm looking for by replacing 'return' with 'die' but that results in a white page and looks rather rubbish so its not really a great solution.

I would imagine there must be a better way to achieve this, any thoughts?

Would it be possible to do this check via a hook before uninstallation and abort before we get to the point of running the uninstall() method, as I imagine that is what updates the DB to turn the module off so to speak? 

Share this post


Link to post
Share on other sites

I think you just need to make sure you don't return from ___uninstall. Throwing an exception should be sufficient, though I haven't tested it.

if(! $this->canWeUninstall()) {
	throw new WireException("Whoops! Module cant be uninstalled as it appears to be in use.");
}

 

  • Like 2

Share this post


Link to post
Share on other sites
13 hours ago, BitPoet said:

I think you just need to make sure you don't return from ___uninstall. Throwing an exception should be sufficient, though I haven't tested it.


if(! $this->canWeUninstall()) {
	throw new WireException("Whoops! Module cant be uninstalled as it appears to be in use.");
}

 

That works a treat, thanks man!

  • Like 1

Share this post


Link to post
Share on other sites

This is what I came up with today: I have a main module that installs 3 other modules (via module info "installs" => ["mod1", "mod2", "mod3"]). Uninstall was a bit of a problem, because it tried to uninstall a fieldtype module and this was not possible when I had an existing field of that type. Throwing an exception did also not work, because all submodules where uninstalled even if the main module threw an exception. I then tried to throw an exception in all of the submodules as well, but that was a mess and did not work reliably.

Hooks to the rescue:

  public function init() {
    $this->addHookBefore("Modules::uninstall", $this, "customUninstall");
  }


  /**
   * Custom uninstall routine
   * 
   * @param HookEvent $event
   */
  public function customUninstall($event) {
    $class = $event->arguments(0);
    if($class != 'yourmodulename') return;

    // set flag
    $abort = false;
    
    // check1
    if($this->check1() == false) {
      $this->error('check1 failed');
      $abort = true;
    }

    // check2
    if($this->check2() == false) {
      $this->error('check2 failed');
      $abort = true;
    }

    // uninstall?
    if($abort) {
      // there where some errors
      $event->replace = true; // prevents original uninstall
      $this->session->redirect("./edit?name=$class"); // prevent "module uninstalled" message
    }
  }

Real life example that also checks if the uninstalled module is the main module or a sub-module. If it is a sub-module it shows an error and redirects to the config screen of the main module:

GUS739t.png

otoP2Mi.png

  public function init() {
    $this->addHookBefore("Modules::uninstall", $this, "customUninstall");
  }


  /**
   * Custom uninstall routine
   * 
   * @param HookEvent $event
   */
  public function customUninstall($event) {
    $installs = $this->getModuleInfo();
    $class = $event->arguments(0);
    $url = "./edit?name=$class";

    // exit when class does not match
    if(!in_array($class, $installs)) return;
    
    // intercept uninstall
    $abort = false;

    // if it is not the main module we redirect to the main module's config
    if($class != 'RockMarkup') {
      $abort = true;
      $url = "./edit?name=RockMarkup";
      $this->error('Please uninstall the main module');
    }
    
    // check if any fields exist
    $fields = $this->wire->fields->find('type=FieldtypeRockMarkup')->count();
    if($fields > 0) {
      $this->error('Remove all fields of type RockMarkup before uninstall!');
      $abort = true;
    }

    // on uninstall of the main module we remove this hook so that it does
    // not interfere with the auto-uninstall submodules
    if($class == 'RockMarkup') $event->removeHook(null);

    // uninstall?
    if($abort) {
      // there where some errors
      $event->replace = true; // prevents original uninstall
      $this->session->redirect($url); // prevent "module uninstalled" message
    }
  }

 

  • Like 1

Share this post


Link to post
Share on other sites
On 7/12/2019 at 5:37 PM, bernhard said:

Real life example that also checks if the uninstalled module is the main module or a sub-module. If it is a sub-module it shows an error and redirects to the config screen of the main module:

Hi @bernhard, I have the same situation and just stumbled across your post here! Great solution!

Where do I setup this hook? In main module or the submodule?

Share this post


Link to post
Share on other sites
11 minutes ago, bernhard said:

I see you placed the hook into the main modules init method. But how is this hook triggered when someone tries to uninstall the submodule?

Share this post


Link to post
Share on other sites

It's triggered by all uninstalls of modules that are based on the main module (like RockTabulator is based on RockMarkup2). And those modules extend the main module and therefore the init method is called on every load of the submodule.

Share this post


Link to post
Share on other sites
6 minutes ago, bernhard said:

It's triggered by all uninstalls of modules that are based on the main module (like RockTabulator is based on RockMarkup2). And those modules extend the main module and therefore the init method is called on every load of the submodule.

Hmm.. my FieldType module (and the two other submodules) isn't based on the main module so it seems I need to place the hook into the FieldType module?

Share this post


Link to post
Share on other sites

I've read my post above and I'm not sure if I was offtopic at that time or if my post 10min ago was not 100% correct. I'm working hard on my DateRange field though, so I've no time for digging into that. What is your exact scenario?

Share this post


Link to post
Share on other sites

I'm developing a module which comes with 3 other integrated (and required) modules. On of them is a custom selector FieldType which gets its data from a helper class within the main module. The problem is if one wants to uninstall the main module but wants to preserve the pages which uses the custom selector FieldType, the uninstallation process is interrupted as this FieldType is still in use.

I first thought to simply let the FieldType installed (standalone), but it has dependencies in a helper class which won't work when main module is uninstalled.

Share this post


Link to post
Share on other sites

Yeah, I guess PW's module dependency features are too limited for such cases. I think you'd need to remove the dependencies in the module's info array and implement them on your own somewhere in the modules' install() and uninstall() methods.

  • Like 1

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 MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
×
×
  • Create New...