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 Robin S
      Another little admin helper module...
      Template Field Widths
      Adds a "Field widths" field to Edit Template that allows you to quickly set the widths of inputfields in the template.

      Why?
      When setting up a new template or trying out different field layouts I find it a bit slow and tedious to have to open each field individually in a modal just to set the width. This module speeds up the process.
      Installation
      Install the Template Field Widths module.
      Config options
      You can set the default presentation of the "Field widths" field to collapsed or open. You can choose Name or Label as the primary identifier shown for the field. The unchosen alternative will become the title attribute shown on hover. You can choose to show the original field width next to the template context field width.  
      https://github.com/Toutouwai/TemplateFieldWidths
      https://modules.processwire.com/modules/template-field-widths/
    • By horst
      Croppable Image 3
      for PW 3.0.20+
      Module Version 1.1.16
      Sponsored by http://dreikon.de/, many thanks Timo & Niko!
      You can get it in the modules directory!
      Please refer to the readme on github for instructions.
       
      -------------------------------------------------------------------------
       
      Updating from prior versions:
       
      Updating from Croppable Image 3 with versions prior to 1.1.7, please do this as a one time step:
      In the PW Admin, go to side -> modules -> new, use "install via ClassName" and use CroppableImage3 for the Module Class Name. This will update your existing CroppableImage3 module sub directory, even if it is called a new install. After that, the module will be recogniced by the PW updater module, what makes it a lot easier on further updates.
      -------------------------------------------------------------------------
       
      For updating from the legacy Thumbnail / CropImage to CroppableImage3 read on here.
       
      -------------------------------------------------------------------------
       
    • By MoritzLost
      UPDATE: I have published a stable version of this module!
      Discussion thread:
      Github: https://github.com/MoritzLost/TextformatterPageTitleLinks
      ---
      Hello there,
      I'm working on a tiny textformatter module that searches the text for titles of other pages on your site and creates hyperlinks to them. I'm not sure if something like this exists already, but I haven't found anything in the module directory, so I wrote my own solution 🙂
      It's not properly tested yet and is still missing some functionality I would like to implement, so at the moment it should be considered in BETA. Features include limiting the pages that will get searched by template, and adding a custom CSS class to the generated hyperlinks. As I'm writing this I noticed that it will probably include unpublished and hidden pages at the moment, so yeah ... it's still in development alright 😅
      You can download the module from Github:
      https://github.com/MoritzLost/TextformatterPageTitleLinks
      There's some more information in the readme as well.
      Anyway, let me know what you think! I'm happy about any feedback, possible improvements or ideas on how to improve the module. Cheers.
    • By blad
      Hi guys!
      I just uploaded a module to explore files based on elFinder. By default it will show the "Files" folder.
      Screenshots:

      Video:
       
      To do:
       More options To fix:
       The function of rotating or scaling an image fails  Image editors V 1.01 (view issue)
      Fixed the bug working with the Multi-Language support ( translation of folders ). Fixed the name of elfinder.en  Github:
      https://github.com/LuisSantiago/ProcessElFinder/
      I hope you like it.
    • By BitPoet
      I'm really in love with FormBuilder, but the one thing missing to match all my end users' expectations were repeatable field groups. Think repeaters, in ProcessWire terms. Our primary application of PW is our corporate intranet, so "lines" of fields are quite common in the forms I build. We have all kinds of request forms where the information for a varying number of colleagues needs to be entered (from meal order to flight booking request) and where it is simply impractical to send a form for each, and I don't want to clutter my forms with multiple instances of fields that may only get used ten percent of the time.
      That's why I started to build FormBuilderMultiplier (link to GitHub).
      What it does:
      Adds an option to make a regular Fieldgroup repeatable Lets you limit the number of instances of a Fieldgroup on the form Adds an "Add row" button the form that adds another instance of the Fieldgroup's fields Adds a counter suffix at the end of every affected field's label Stores the entered values just like regular fields Makes the entered values available in preview and email notifications Supports most text based fields, textareas and selects (really, I haven't had enough time to test all the available choices yet) What it doesn't do (yet):
      Support saving to ProcessWire pages (i.e. real Repeaters) I haven't tested all the validation stuff, Date/Time inputs etc. yet, but since I'm utterly swamped with other stuff at work, I didn't want to wait until I have it polished. Any feedback is welcome. There might also be some issues with different output frameworks that I haven't encountered yet. The forms I work with mostly use UIKit.
      Status:
      Still alpha, so test well before using it in the field.
      Known issues:
      When rows are added, the form's iframe needs to be resized, which isn't completely clean yet.
      How it works:
      The Fieldgroup settings are added through regular hooks, as is the logic that adds the necessary field copies for processing the form and displaying previews.
      "Multiplied" field instances are suffixed with _NUM, where NUM is an incremental integer starting from 1. So if you have add two fields named "surname" and "givenname" to a fieldgroup and check the "multiply" checkbox, the form will initially have "surname_1" and "givenname_1" field (I'm still considering changing that to make the risk to shoot oneself into the foot by having a regular "surname_1" field somewhere else in the form less likely).
      When a "row" is added, the first row is cloned through JS and the counter in the fields' IDs, names and "for" attributes as well as the counter in the label are incremented before appending the copies to the Fieldset container in the form.
      To keep backend and frontend in sync, a hidden field named [name of the fieldset]__multiplier_rows is added to the form. Both the backend and the frontend script use this to store and retrieve the number of "rows".
      ToDo:
      Naturally, add the option to store the data in real repeaters when saving to pages. Do a lot of testing (and likely fixing). Make a few things (like the "Add row" button label etc.) configurable in field(set) context. Add a smooth API to retrieve the multiplied values as WireArrays. The mandatory moving screenshot: