Jump to content
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

@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

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      Repeater Images
      Adds options to modify Repeater fields to make them convenient for "page-per-image" usage. Using a page-per-image approach allows for additional fields to be associated with each image, to record things such as photographer, date, license, links, etc.
      When Repeater Images is enabled for a Repeater field the module changes the appearance of the Repeater inputfield to be similar (but not identical) to an Images field. The collapsed view shows a thumbnail for each Repeater item, and items can be expanded for field editing.
      Screencast

      Installation
      Install the Repeater Images module.
      Setup
      Create an image field to use in the Repeater field. Recommended settings for the image field are "Maximum files allowed" set to 1 and "Formatted value" set to "Single item (null if empty)". Create a Repeater field. Add the image field to the Repeater. If you want additional fields in the Repeater create and add these also. Repeater Images configuration
      Tick the "Activate Repeater Images for this Repeater field" checkbox. In the "Image field within Repeater" dropdown select the single image field. You must save the Repeater field settings to see any newly added Image fields in the dropdown. Adjust the image thumbnail height if you want (unlike the core Images field there is no slider to change thumbnail height within Page Edit). Note: the depth option for Repeater fields is not compatible with the Repeater Images module.
      Image uploads feature
      There is a checkbox to activate image uploads. This feature allows users to quickly and easily add images to the Repeater Images field by uploading them to an adjacent "upload" field.
      To use this feature you must add the image field selected in the Repeater Images config to the template of the page containing the Repeater Images field - immediately above or below the Repeater Images field would be a good position.
      It's recommended to set the label for this field in template context to "Upload images" or similar, and set the visibility of the field to "Closed" so that it takes up less room when it's not being used. Note that when you drag images to a closed Images field it will automatically open. You don't need to worry about the "Maximum files allowed" setting because the Repeater Images module overrides this for the upload field.
      New Repeater items will be created from the images uploaded to the upload field when the page is saved. The user can add descriptions and tags to the images while they are still in the upload field and these will be retained in the Repeater items. Images are automatically deleted from the upload field when the page is saved.
      Tips
      The "Use accordion mode?" option in the Repeater field settings is useful for keeping the inputfield compact, with only one image item open for editing at a time. The "Repeater item labels" setting determines what is shown in the thumbnail overlay on hover. Example for an image field named "image": {image.basename} ({image.width}x{image.height})  
      https://github.com/Toutouwai/RepeaterImages
      https://modules.processwire.com/modules/repeater-images/
    • By EyeDentify
      Hello There Guys.

      I am in the process of getting into making my first modules for PW and i had a question for you PHP and PW gurus in here.

      I was wondering how i could use an external library, lets say TwitterOAuth in my PW module.
      Link to library
      https://twitteroauth.com/

      Would the code below be correct or how would i go about this:
      <?PHP namespace ProcessWire; /* load the TwitterOAuth library from my Module folder */ require "twitteroauth/autoload.php"; use Abraham\TwitterOAuth\TwitterOAuth; class EyeTwitter extends WireData,TwitterOAuth implements Module { /* vars */ protected $twConnection; /* extend parent TwitterOAuth contructor $connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $access_token, $access_token_secret); */ public function myTwitterConnection ($consumer_key, $consumer_secret, $access_token, $access_token_secret) { /* save the connection for use later */ $this->twConnection = TwitterOAuth::__construct($consumer_key, $consumer_secret, $access_token, $access_token_secret); } } ?> Am i on the right trail here or i am barking up the wrong tree?
      I don´t need a complete solution, i just wonder if i am including the external library the right way.
      If not, then give me a few hint´s and i will figure it out.

      Thanks a bunch.

      /EyeDentify
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

×
×
  • Create New...