WebSVN – computer_asset_manager_v1 – Diff – //modules/sysinfo/cli_tools/getSysinfoMail.php

  * apt-get install php5-imap
+ *
  * Good information taken from
  * http://docstore.mik.ua/orelly/webprog/pcook/ch17_04.htm
+ *
+ * V1.1 20160203 RWR
+ * Changed to use yaml for the configuration file. Had to take the
+ * anonymous functions which parsed the different file types and convert
+ * them to simpl eval() blocks.
+ *
  */
-$VERSION = '1.0';
+$VERSION = '1.1';
 $MAXDOWNLOAD = 5000; // maximum number of e-mails to download at one time
 $CLI = isset( $_SERVER["TERM"]); // only set if we are not in a cron job
+/*
+ * we don't know where the configuration file will be, so we have a list
+ * below (searchPaths) to look for it. It will load the first one it
+ * finds, then exit. THUS, you could have multiple configuration files
+ * but only the first one in the list will be used
+ */
+$confFileName = "sysinfoRead.conf.yaml";
+$searchPaths = array( '/etc/camp', '/opt/camp', '/opt/camp/sysinfo', $_SERVER['SCRIPT_FILENAME'], getcwd() );
+$configuration = array();
+foreach ( $searchPaths as $path ) {
+   if ( file_exists( "$path/$confFileName" ) ) {
+      print "Found $path/$confFileName\n";
+      $configuration = yaml_parse_file( "$path/$confFileName" );
-require "sysinfoRead.php.conf";
+      #require "$path/$confFileName";
+      break; // exit out of the loop; we don't try to load it more than once
+   } // if
+} // foreach
+/*
+ * function    OpenMailbox
+ * Parameters: $username
+ *             $password
+ *             $server
+ *             $ssl=true
+ *             $port=null
+ *             $mailbox='INBOX'
+ *
+ * Returns:    The IMAP instance handle
+ *             The server string (used by some functions)
+ */
 function OpenMailbox ( $username, $password, $server, $ssl = true, $port=null, $mailbox = 'INBOX' ) {
    if ( $port == null )
       if ( $ssl ) $port = 993;  else $port = 143;
    $server = gethostbyname( $server );
    $serverString = "$server:$port/imap";
    $server = imap_open( $serverString, $username, $password );
    return array($server, $serverString);
+}
+/*
+ * function  getContents
+ * Paramters $mail - handle to the connection
+ *           $n    - the # of the message to get
+ * Returns   The type of report (yaml,xml,ini)
+ *           The contents of the above
+ *
+ * See getBody() below
+ *
+ * At the very end, calls getBody, which evaluates the type of file
+ * for a valid yaml/xml/ini file
+ */
 function getContents ($mail, $n ) {
    $body = '';
    $st = imap_fetchstructure($mail, $n);
    if (!empty($st->parts)) {
        for ($i = 0, $j = count($st->parts); $i < $j; $i++) {
        $body = imap_body($mail, $n);
+   }
    return getBody( $body );
+}
+/*
+ * function  getBody
+ * Parameter $body
+ * Returns   type of report (yaml, ini, xml)
+ *           contents of the report
+ * Returns (false,'') if nothing found
+ *
+ * Removes all cruft from the message, leaving only a yaml, xml
+ * or ini. For example, anything before --- in a yaml file is remove
+ * as is everything after ..., and in this case, the first return
+ * would be the string 'yaml' and the second the actual yaml document
+ */
 function getBody ( $body ) {
-   global $bodyContents;
+   global $configuration;
-   foreach ( $bodyContents as $key => $regexes ) {
+   foreach ( $configuration['bodyContents'] as $key => $regexes ) {
       $matches;
       $pattern = $regexes['startTag'] . '.*' . $regexes['endTag'];
       if ( preg_match( "/$pattern/ms", $body, $matches ) )
          return array( $key, $matches[0] );
+   }
    return array( false, '' );
+}
+/* function makeFileName
+ * Parameter $data
+ *           $type - the type of the file
+ * Returns   properly formatted file name for saving
+ *
+ * The file name is created as a combination of the report date
+ * client name, hostname and serial number, separated by the underscore
+ * character. The type of the file is appended, and the configuration
+ * value for outpath is prepended
+ */
 function makeFileName ( $data, $type ) {
-   global $outpath;
+   global $configuration;
+   $outpath = $configuration['outpath'];
    // we will create filename as yyyy-mm-dd_HH:mm:ss_client_hostname_serial
    $date =  empty( $data['report']['date'] ) ? '' : strtotime( $data['report']['date'] ); // store in Unix timestamp
    $date = strftime( '%F_%T', $date ); // save a copy of the date in SQL format
    // add client name
    $serial = empty ( $data['system']['serial'] ) ? '00000' : $data['system']['serial'];
    return ( $date && $client && $hostname && $serial ) ? "$outpath/$date" . '_' . $client . '_' . $hostname . '_' . "$serial.$type" : false;
+}
+/*
+ * function saveFile
+ * parameter $filename
+ *           $contents
+ *           $timestamp
+ * returns   Number of bytes written
+ *
+ * Saves $contents to file $filename, then sets the timestamp to
+ * $timestamp. It is assumed $filename was created by makeFileName
+ * and $contents is the content of a report. $timestamp is the actual
+ * report timestamp
+ */
 function saveFile( $filename, $contents, $timestamp ) {
    $bytesWritten = file_put_contents( $filename, $contents );
    if ( $bytesWritten ) {
       if ( ! touch( $filename, $timestamp ) ) logError( "could not set timestamp of $filename to $timestamp" );
+   }
    return $bytesWritten;
+}
 function logError ( $message ) {
-   global $logFile;
+   global $configuration;
-   error_log( "$message\n", 3, $logFile );
+   error_log( "$message\n", 3, $configuration['logFile'] );
+}
 /**************************************************************************************************************
  * Begin Main Program
  **************************************************************************************************************/
 // ensure the path we want to write to exists
-if ( ! is_dir( $outpath ) ) {
+if ( ! is_dir( $configuration['outpath'] ) ) {
-   if ( ! mkdir( $outpath, 0777, true ) ) {
+   if ( ! mkdir( $configuration['outpath'], 0777, true ) ) {
-      die( "Could not create path $outpath\n" );
+      die( "Could not create path " . $configuration['outpath'] . "\n" );
+   }
+}
 $listMailboxes =  isset( $argv[1] ) ; // anything passed on cli results in a list of mailboxes instead of the job
-foreach ( $servers as $thisServer ) {
+foreach ( $configuration['servers'] as $thisServer ) {
    if ($MAXDOWNLOAD <= 0 ) break;
    if ( ! $thisServer['enabled'] ) continue; // ignore anything that is not enabled
    print "Working on " . $thisServer['servername'] . "\n";
    $messagesToDelete = array(); // trap the UID's of messages to delete, more accurate than using message number
    print "Opening " . $thisServer['servername'] . "\n";
                                                 );
    print "Success with $connectString\n";
    if ( $listMailboxes ) {
       $list = imap_list($server, $connectString, "*");
       print_r( $list ); print "\n";
-      continue;
+   }
    $count = 0;
    if ( $server ) {
       $folderCount = imap_num_msg( $server );
       for ( $num = 1; ($num <= $folderCount) && $MAXDOWNLOAD; $num++ ) {
          list( $type,$body ) = getContents( $server, $num );
          if ( ! $type ) {
             logError( "Unknown File Type" );
             continue;
+         }
-         if ( ! ($data = $bodyContents[$type]['eval']($body) ) ) {
+         $data = eval( $configuration['bodyContents'][$type]['eval'] );
+         if ( ! $data ) {
             logError( "Unable to parse file" );
             continue;
+         }
          if ( !(  $filename  = makeFileName( $data, $type ) ) ) {
             logError( "unable to create a file name" );

Subversion Repositories computer_asset_manager_v1

(root)//modules/sysinfo/cli_tools/getSysinfoMail.php – Rev 3 → 5