Uploaded image for project: 'Log4php'
  1. Log4php
  2. LOG4PHP-117

LoggerConfiguratorIni::configure() and unexptected results from error_get_last()

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Fixed
    • 2.0.0
    • 2.1.0
    • Code
    • None

    Description

      This apply to src/main/php/configurators/LoggerConfiguratorIni.php
      If you invoke LoggerConfiguratorIni::configure() after there was any notice or warning in your PHP script, then LoggerConfiguratorIni will throw an exception even if there is no need (propably terminating execution)

      284 public function configure(LoggerHierarchy $hierarchy, $url = '') {
      285 $properties = @parse_ini_file($url);
      286 if ($properties === false || count($properties) == 0)

      { 287 $error = error_get_last(); 288 throw new LoggerException("LoggerConfiguratorIni: ".$error['message']); 289 }

      290 return $this->doConfigureProperties($properties, $hierarchy);
      291 }

      In line 287 it is checked if there was any error triggered by function parse_ini_file(). Unfortunately function error_get_last() doesn't return an error triggered by execution of the last function. It returnes an error that is most recent in global, even if it was already catched and taken care of. This is because there is no way to reset the state of the last error. It returns always the last triggered error. (http://www.php.net/manual/en/function.error-get-last.php#83608)

      I attached the patch that "solves" this by triggering an empty error before parse_ini_file(), and the it is checked if the error has an empty message:

      public function configure(LoggerHierarchy $hierarchy, $url = '') {
      @trigger_error('');
      $properties = @parse_ini_file($url);
      if ($properties === false || count($properties) == 0) {
      $error = error_get_last();
      if ($error['message'] != '')

      { throw new LoggerException("LoggerConfiguratorIni: ".$error['message']); }

      }
      return $this->doConfigureProperties($properties, $hierarchy);
      }

      This not very pretty but it works

      Attachments

        1. error_get_last_patch_v2
          1.0 kB
          Ivan Habunek
        2. error_get_last_patch
          0.9 kB
          Maciej Mazur

        Activity

          mamciek Maciej Mazur added a comment -

          I attached patch solving this issue

          mamciek Maciej Mazur added a comment - I attached patch solving this issue
          grobmeier Christian Grobmeier added a comment - - edited

          Actually this is a pretty bad behaviour of Log4PHP. Thanks for bringing this up.
          I am not sure if triggering an empty error is what we should do here.

          I am also not sure if we really need the error_get_last. If we have false properties or a count of 0, then its very clear that its something wrong with the properties file. We can raise the exception without knowing the exact case. Maybe this would be enough:

          throw new LoggerException("LoggerConfiguratorIni could not parse properties file: ".$url);

          and dropping of trigger_error and error_get_last

          What do you think?

          grobmeier Christian Grobmeier added a comment - - edited Actually this is a pretty bad behaviour of Log4PHP. Thanks for bringing this up. I am not sure if triggering an empty error is what we should do here. I am also not sure if we really need the error_get_last. If we have false properties or a count of 0, then its very clear that its something wrong with the properties file. We can raise the exception without knowing the exact case. Maybe this would be enough: throw new LoggerException("LoggerConfiguratorIni could not parse properties file: ".$url); and dropping of trigger_error and error_get_last What do you think?
          mamciek Maciej Mazur added a comment - - edited

          Actually i don't think it should be thrown anything if there is no file, or file contains no properties. A warning or notice could be printed (to stderr), but there is no need to throw an exception (I belive log4j behaves like this).

          mamciek Maciej Mazur added a comment - - edited Actually i don't think it should be thrown anything if there is no file, or file contains no properties. A warning or notice could be printed (to stderr), but there is no need to throw an exception (I belive log4j behaves like this).
          juice Ivan Habunek added a comment - - edited

          I think you're going about this the wrong way. parse_ini_file() returns FALSE when an error occured which can then be fetched by error_get_last(). Therefore, error_get_last should only be called if parse_ini_file returns FALSE. It should not be called when it returns an empty array. An empty array is returned when you successfully parse an empty config file.

          I propose the following solution:

          	public function configure(LoggerHierarchy $hierarchy, $url = '') {
          		$properties = @parse_ini_file($url);
          		if ($properties === false) {
          			$error = error_get_last();
          			throw new LoggerException("LoggerConfiguratorIni: Error parsing configuration file: ".$error['message']);
          		}
          		if  (count($properties) == 0) {
          			trigger_error("LoggerConfiguratorIni: Configuration file is empty.", E_USER_WARNING);
          		}
          		return $this->doConfigureProperties($properties, $hierarchy);
          	} 
          

          As you proposed, a warning is issued if there are no values in the config file.

          juice Ivan Habunek added a comment - - edited I think you're going about this the wrong way. parse_ini_file() returns FALSE when an error occured which can then be fetched by error_get_last(). Therefore, error_get_last should only be called if parse_ini_file returns FALSE. It should not be called when it returns an empty array. An empty array is returned when you successfully parse an empty config file. I propose the following solution: public function configure(LoggerHierarchy $hierarchy, $url = '') { $properties = @parse_ini_file($url); if ($properties === false ) { $error = error_get_last(); throw new LoggerException( "LoggerConfiguratorIni: Error parsing configuration file: " .$error[ 'message' ]); } if (count($properties) == 0) { trigger_error( "LoggerConfiguratorIni: Configuration file is empty." , E_USER_WARNING); } return $ this ->doConfigureProperties($properties, $hierarchy); } As you proposed, a warning is issued if there are no values in the config file.
          mamciek Maciej Mazur added a comment -

          The above solution is good in my opinion. It solves everything.

          mamciek Maciej Mazur added a comment - The above solution is good in my opinion. It solves everything.
          juice Ivan Habunek added a comment -

          Here's a patch.

          BTW; how do you get indented code in comments? The

          
          

          tags used in wiki don't work. Do you use pre tags?

          juice Ivan Habunek added a comment - Here's a patch. BTW; how do you get indented code in comments? The tags used in wiki don't work. Do you use pre tags?
          mamciek Maciej Mazur added a comment -

          I don't remember how i did this I belive a just manually added spaces

          mamciek Maciej Mazur added a comment - I don't remember how i did this I belive a just manually added spaces
          juice Ivan Habunek added a comment -

          Committed in revision 979738.

          juice Ivan Habunek added a comment - Committed in revision 979738.

          People

            Unassigned Unassigned
            mamciek Maciej Mazur
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: