netcarver

ProcessDiagnostics

Recommended Posts

Introducing ProcessDiagnostics and it's helper module suite. (Is this ProcessWire's first community-created module suite?)

post-465-0-19487500-1401132201_thumb.png post-465-0-70031800-1401214763_thumb.jpg

Description

This suite adds a page under the setup menu that displays information about your installation. Each section's data is provided by a specialist diagnostic helper module but it is all collected and displayed by ProcessDiagnostics.

The ProcessDiagnostics module itself does not encode any knowledge about what makes up a good or bad setting in PW - (that's done by the helper modules) - but it does the following...

  • Gather the diagnosics (thanks to PW's hook system)
  • Display the collected diagnostics
  • Provide helper functions for describing some common things
  • Dispatch actions to diagnostic provider modules (again thanks to PW's hook system)

And eventually it will:

  • Allow control of the verbosity of the output
  • Allow the output to be emailed to a sysop
  • Store the results between visits to the page
  • Detect differences between results at set times
  • Send a notification on detection of changes

Although I am curating the collection, anyone is welcome to fork the repo, make changes in a topic branch, and submit pull requests. I've already had submissions from horst and Nico.

Diagnostic Providers

The current diagnostic providers include...

DiagnosePhp - Simple diagnostics about the PHP envirnoment on the server

DiagnoseModules - An ajax based module version checker by @Nico

DiagnoseImagehandler - Lets you know about GD + Imagick capabilities by @horst

DiagnoseDatabase - Checks each DB table and lets you know what engine and charset are in use

DiagnoseWebserver - Checks the webserver setup

DiagnoseFilesystem - Looks at how your directory and files are configured and warns of permission issues (currently incomplete)

There is also a bare bones demonstration diagnostic module...

DiagnoseExample - minimal example to get module authors started.

Translations

English & German (thank you @Manfred62!)

Help translating this suite to other languages is always welcome.

On The Net

Check out Nico's blog post about this suite on supercode.co!

  • Like 21

Share this post


Link to post
Share on other sites

As of v0.0.2 you should be able to hook ProcessDiagnostics::CollectDiagnostics() to either append or modify collected diagnostic data as required. Minimal cell highlighting now added for failure lines (see picture in the opening post.)

  • Like 1

Share this post


Link to post
Share on other sites

Steve,

I am wondering if it is useful to also include the CHMOD values (777, etc)? Just thinking out loud...

Very, very trivial request: Please change Ok to OK...  :lol:  :P  ;)

  • Like 1

Share this post


Link to post
Share on other sites

@kongondo

Done and done as v0.0.3. Initial post updated to show output.

  • Like 1

Share this post


Link to post
Share on other sites

@Steve: maybe sooner or later it would be good to group the diagnostics ( $results['group_name'][] = ...), what do you think?

Here is a snippet for php version that has max memory and system info. Take from it what you think is useful.

I will provide one other for images stuff.

    protected function getPhpDiagnostics() {

        $ver     = null;   // string  PHP Version
        $mem     = null;   // string  Max Memory for PHP
        $api     = null;   // string  full api info
        $sys     = null;   // string  full sys info

        ob_start();
        phpinfo(INFO_GENERAL);
        $buffer = str_replace("\r\n", "\n", ob_get_contents());
        ob_end_clean();

        $ver = phpversion();

        $mem = trim(ini_get('memory_limit'));

        $pattern = preg_match('#</td>#msi', $buffer)===1 ? '#>Server API.*?</td><td.*?>(.*?)</td>#msi' : '#\nServer API.*?=>(.*?)\n#msi';
        $api = preg_match($pattern, $buffer, $matches)===1 ? trim($matches[1]) : null;

        $pattern = preg_match('#</td>#msi', $buffer)===1 ? '#>System.*?</td><td.*?>(.*?)</td>#msi' : '#\nSystem.*?=>(.*?)\n#msi';
        $sys = preg_match($pattern, $buffer, $matches)===1 ? trim($matches[1]) : null;

        // build results array version

        $pwver = $this->config->version;
        $php53 = version_compare($ver, '5.3.8', '>=');
        if(!$php53) {
            $res = version_compare($pw, '2.4.0', '<');  // I don't know which is the last PW version that can run with 5.2.x
            $action = $res ? '' : $this->_('Explanation of any problem or action needed to correct.');
        }
        else {
            $res = true;
            $action = $this->_(sprintf('running ProcessWire %s with PHP %s is fine', $pwver, $ver));
        }
        $results['php'][] = array(
            'title'  => $this->_('PHP Version'),
            'value'  => $ver,
            'status' => $res ? $this->_('Ok') : $this->_('Fail'),
            'action' => $action
        );

        // build results array PHP Handler

        $res = true;
        $action = '';
        $results['php'][] = array(
            'title'  => $this->_('PHP Handler'),
            'value'  => $api,
            'status' => $res ? $this->_('Ok') : $this->_('Fail'),
            'action' => $action
        );

        // build results array PHP max memory

        $res = true;
        $action = '';
        $results['php'][] = array(
            'title'  => $this->_('PHP max Memory'),
            'value'  => $mem,
            'status' => $res ? $this->_('Ok') : $this->_('Fail'),
            'action' => $action
        );

        // build results array PHP system info

        $res = true;
        $action = '';
        $results['php'][] = array(
            'title'  => $this->_('System Information'),
            'value'  => $sys,
            'status' => $res ? $this->_('Ok') : $this->_('Fail'),
            'action' => $action
        );

        return $results;
    }
  • Like 4

Share this post


Link to post
Share on other sites

just a question: shouldn't this module show up in the setup section? Is there something to be done to see the results? Using latest dev of PW.

Hint: to make it full translatable you have to use a newline, otherwise it will not be found (see example):

line 170: 'value'  => $rewrite_ok ? $this->_('Installed') : $this->_('Not installed'),

// must be

line 170: 'value'  => $rewrite_ok ? $this->_('Installed') : 
                                    $this->_('Not installed'),
  • Like 3

Share this post


Link to post
Share on other sites

@horst

Thanks for taking the time to submit this!  Perhaps this can become the first community developed module for PW if others want to get involved too :)

Splitting the results into sections looks like a good idea - I'll work that into the display code. In the meantime, I've added several class variables that we can use for the 'OK', 'Failure' and (new) 'Warning' messages.  Going forward, if people could use self::$ok, self::$fail or self::$warn for the 'status' entry that will simplify things.

@Manfred62

Thank you for the feedback, I was unaware of the need to separate different strings with linebreaks for the translator to find them.

Regarding the location of the diagnostics output page; yes, it should show up under the Setup menu.  At least, it does on my fairly recent dev version (not the latest though.)

Edited to add: Updated the opening post image.

  • Like 3

Share this post


Link to post
Share on other sites

Could some one add a check if /site/install/ is deleted? Because it's a potential risk to leave it.

  • Like 2

Share this post


Link to post
Share on other sites

@Steve, for what is the parent::init() parent::install() in the install routine?

When I try to install the module my server (apache windows) crashes and after reloading the browserpage I have the module installed but not the Diagnostics Page created.

I haven't investigated much further, but the code where it comes to the interrupt is not in your module, but is it needed / common usage to do the call for parent::install?

Also if it is common, if something break like in my situation, the uninstall routine of your module (and every other module where this happens) is affected when it try to delete a page that wasn't created.

Would it be better to check if $p->id > 0 before trying to delete, and in the init() or ready() if the Diagnostics Page exists?

---

Another one I have from @adrian: on some servers the phpinfo() could be disabled, therefor a check for it would be good. I have forgotten to implement it in my previously posted code:

        /**
         * returns if function is disabled in php
         *
         * @return boolean: true, false
         */
        static protected function isDisabled($function) {
            $disabled_functions = explode(',' , str_replace(' ', '', strtolower(ini_get('disable_functions'))));
            return in_array(strtolower($function), $disabled_functions);
        }
Edited by horst
  • Like 2

Share this post


Link to post
Share on other sites

Also it could be good to add some or many (?) checks into it that are normally run with the installer?

This could be very useful when people just ftp-ing their site-profile from dev to live and send a mysql_dump along the same way.

Edited by horst
  • Like 1

Share this post


Link to post
Share on other sites

@horst

I'm not sure re the call to the parent install routine. Will look into it. In the meantime, you are right about adding a check on the page id before trying to delete the page on uninstall. I do plan on cribbing some of Ryan's pre- and post-install code to see if we can re-use it usefully in the module.

BTW, I don't have a windows machine to test this on so anything you turn up will be useful.

@Nico

Noted. Thank you.

  • Like 1

Share this post


Link to post
Share on other sites

Here is the getImagesDiagnostics():

    protected function getImagesDiagnostics() {

        // check for GD-lib

        if(!function_exists('gd_info')) {
            #$results['images'][] = array(
            $results[] = array(
                'title'  => $this->_('GD library'),
                'value'  => $ver,
                'status' => self::$fail,
                'action' => $this->_('There seems to be no GD-library installed!')
            );
        }
        else {
            $gd  = gd_info();
            $ver = isset($gd['GD Version']) ? $gd['GD Version'] : $this->_('Version-Info not available');
            $jpg = isset($gd['JPEG Support']) ? $gd['JPEG Support'] : false;
            $png = isset($gd['PNG Support']) ? $gd['PNG Support'] : false;
            $gif = isset($gd['GIF Read Support']) && isset($gd['GIF Create Support']) ? $gd['GIF Create Support'] : false;
            $freetype = isset($gd['FreeType Support']) ? $gd['FreeType Support'] : false;

            // GD version
            #$results['images'][] = array(
            $results[] = array(
                'title'  => $this->_('GD library'),
                'value'  => $ver,
                'status' => self::$ok,
                'action' => ''
            );

            // PHP with GD bug ?
            if((version_compare(PHP_VERSION, '5.5.8', '>') && version_compare(PHP_VERSION, '5.5.11', '<'))) {
                if(version_compare($this->config->version, '2.4.1', '<')) {
                    #$results['images'][] = array(
                    $results[] = array(
                        'title'  => $this->_('GD library Bug'),
                        'value'  => 'possible bug in GD-Version',
                        'status' => self::$warn,  // @steve: or better use self::fail ?
                        'action' => $this->_('Bundled GD libraries in PHP versions 5.5.9 and 5.5.10 are known as buggy. You should update A) your PHP version to 5.5.11 or newer, or B) the ProcessWire version to 2.4.2 or newer')
                    );
                }
            }

            // GD supported types
            foreach(array('JPG', 'PNG', 'GIF', 'FreeType') as $v) {
                $name = $this->_(sprintf('GD %s Support', $v));
                $v = strtolower($v);
                $value = $$v ? $this->_('supported') :
                                $this->_('not supported');
                $status = $$v ? self::$ok : self::$fail;
                #$results['images'][] = array(
                $results[] = array(
                    'title'  => $name,
                    'value'  => $value,
                    'status' => $status,
                    'action' => ''
                );
            }
        }

        // check if we can read exif data

        $res = function_exists('exif_read_data');
        $action = $res ? '' : $this->_("This is not needed for ProcessWire core, but maybe needed with third party modules");
        #$results['images'][] = array(
        $results[] = array(
            'title'  => $this->_('Exif read data'),
            'value'  => $res ? $this->_('available') :
                               $this->_('not available'),
            'status' => $res ? self::$ok : self::$warn,
            'action' => $action
        );

        // check if Imagick is supported

        if(!class_exists('Imagick')) {
            #$results['images'][] = array(
            $results[] = array(
                'title'  => $this->_('Imagick Extension'),
                'value'  => 'not available',
                'status' => self::$warn,
                'action' => $this->_('This is not needed for ProcessWire core, but maybe needed with third party modules')
            );
        }
        else {
            if(self::isDisabled('phpinfo')) {
                #$results['images'][] = array(
                $results[] = array(
                    'title'  => $this->_('Imagick Extension'),
                    'value'  => 'is available',
                    'status' => self::$warn,
                    'action' => $this->_('Odd, retrieving phpinfo on your server is disabled! We cannot get further informations here.')
                );
            }
            else {
                #$results['images'][] = array(
                $results[] = array(
                    'title'  => $this->_('Imagick Extension'),
                    'value'  => 'available',
                    'status' => self::$ok,
                    'action' => ''
                );
                ob_start();
                phpinfo();
                $buffer = ob_get_clean();
                $pattern = '/>imagick<.*?<table.*?(<tr>.*?<\/table>)/msi';
                preg_match($pattern, $buffer, $matches);
                if(isset($matches[1])) {
                    $buf = trim(str_replace('</table>', '', $matches[1]));
                    $a = explode("\n", strip_tags(str_replace(array("\r\n", "\r", '</td><td'), array("\n", "\n", '</td>###<td'), $buf)));
                    $info = array();
                    foreach($a as $line) {
                        if(preg_match('/ImageMagick supported formats/i', $line)) continue;
                        $tmp = explode('###', $line);
                        $k = trim($tmp[0], ': ');
                        $v = str_replace(' http://www.imagemagick.org', '', trim($tmp[1]));
                        #$results['images'][] = array(
                        $results[] = array(
                            'title'  => $k,
                            'value'  => $v,
                            'status' => self::$ok,
                            'action' => ''
                        );
                    }
                }
            }
        }

        return $results;
    }
  • Like 2

Share this post


Link to post
Share on other sites

@horst

It turns out that the call to parent::init() in the init() method does things like automatically including the ProcessDiagnostics.css file in the page output. Well, at least I know now. :)

  • Like 1

Share this post


Link to post
Share on other sites

Oh, my fault. It was a typo: I meant in the parent::install() function, not the init(). Sorry.

Share this post


Link to post
Share on other sites

You are right - class process's install() does nothing. I've removed the parent::install() call.

  • Like 1

Share this post


Link to post
Share on other sites

@horst

Added your Image diagnostics and implemented sections. I updated the image in the opening post to show the results.

  • Like 4

Share this post


Link to post
Share on other sites

Nice one Steve!

I used to love this feature in Textpattern. I'm on holiday next week, but I'll check in to see the goodness you all have come up with when I get back.

  • Like 1

Share this post


Link to post
Share on other sites

@netcarver: Nice, but you don't have to delete "site-default" - only "/site/install/" because site default get's renamed to site while installing.

  • Like 1

Share this post


Link to post
Share on other sites

@Steve: great!

Will you add the handler (apache_module or fcgi) and the MaxMemory to the PHP section?

Share this post


Link to post
Share on other sites

Great one. I was thinking about having this is PW just a couple days ago... and if you wait long enough someone else will do it :P

I think this would be a must have in Core.

  • Like 3

Share this post


Link to post
Share on other sites

 I think this would be a must have in Core.

Exactly!

Share this post


Link to post
Share on other sites

If it's going to be a core module maybe you could even add a "modules" section and show if there are updates for your installed modules. Maybe even with a link to the update if there is one. Shouldn't be that hard to write because module updates are included in the core since 2.3 or 2.4. :)

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 BitPoet
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      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.
      Learn more on my blog
      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.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!