ProcessDiagnostics

[netcarver]

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

 

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!

[kongondo]

Nice one Steve!!

[netcarver]

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.)

[kongondo]

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...     

[netcarver]

@kongondo

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

[horst]

@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;
    }

[Manfred62]

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'),

[netcarver]

@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.

[Nico Knoll]

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

[horst]

@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 May 25, 2014 by horst

[horst]

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 May 25, 2014 by horst

[netcarver]

@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.

[horst]

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;
    }

[netcarver]

@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.

[horst]

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

[netcarver]

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

[netcarver]

@horst

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

[netcarver]

@Nico

Implemented your suggestion. Image updated.

[renobird]

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.

[Nico Knoll]

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

[horst]

@Steve: great!

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

[netcarver]

@Nico

Done. See opening post image.

@horst

Done. Ditto.

[Soma]

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

I think this would be a must have in Core.

[horst]

 I think this would be a must have in Core.

Exactly!

[Nico Knoll]

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.