This class manage web-cron tasks. More...

Public Member Functions
	schedule ()

	lst_cron ()
	List the crontab for the current user. More...

	hook_menu ()
	Hook called by menu class to add menu to the left panel. More...

	update ($arr)
	update the crontab More...

	delete_one ($id)
	delete a crontab More...

	valid_schedule ($s)
	validate a crontab schedule More...

	hook_quota_get ()
	hook for quota computation More...

	execute_cron ()
	Execute the required crontab of AlternC users this function EXIT at the end. More...

	cron_callback ($url, $content, $curl)
	Callback function called by rolling_curl when a cron resulr has been received schedule it for next run and send the mail if needed. More...

	rolling_curl ($urls, $callback, $custom_options=null)
	Launch parallel (using MAX_SOCKETS sockets maximum) retrieval of URL using CURL. More...

Public Attributes
const	MAX_SOCKETS = 8

const	DEFAULT_CAFILE = "/etc/ssl/certs/ca-certificates.crt"

Private Member Functions
	_update_one ($url, $user, $password, $email, $schedule, $id=null)
	update a crontab, More...

Detailed Description

This class manage web-cron tasks.

Copyright: AlternC-Team 2000-2017 https://alternc.com/

Definition at line 26 of file m_cron.php.

Member Function Documentation

◆ _update_one()

m_cron::_update_one	(	$url,
		$user,
		$password,
		$email,
		$schedule,
		$id = `null`
	)

private

update a crontab,

Returns: boolean TRUE if the crontab has been edited

Definition at line 119 of file m_cron.php.

                                                                                         {
         global $db, $msg, $quota, $cuid;
         $msg->log("cron", "update_one");
  
         if (empty($url) && !is_null($id)) {
             return $this->delete_one($id);
         }
  
  
         if (filter_var($url, FILTER_VALIDATE_URL) === false) {
             $msg->raise("ERROR", "cron", _("URL not valid"));
             return false;
         }
         $url = urlencode($url);
         $user = urlencode($user);
         if (empty($user)) {
             $password = '';
         }
         $password = urlencode($password);
  
         //@todo remove checkmail cf functions.php
         if (!empty($email) && !checkmail($email) == 0) {
             $msg->raise("ERROR", "cron", _("Email address is not valid"));
             return false;
         }
         $email = urlencode($email);
         if (!$this->valid_schedule($schedule)) {
             return false;
         }
  
         if (is_null($id)) { // if a new insert, quotacheck
             $q = $quota->getquota("cron");
             if ($q["u"] >= $q["t"]) {
                 $msg->raise("ERROR", "cron", _("You quota of cron entries is over. You cannot create more cron entries"));
                 return false;
             }
         } else { // if not a new insert, check the $cuid
             $db->query("SELECT uid FROM cron WHERE id = ? ;", array($id));
             if (!$db->next_record()) {
                 return "false";
             } // return false if pb
             if ($db->f('uid') != $cuid) {
                 $msg->raise("ERROR", "cron", _("Identity problem"));
                 return false;
             }
         }
         return $db->query("REPLACE INTO cron (id, uid, url, user, password, schedule, email) VALUES (?, ?, ?, ?, ?, ?, ?) ;" , array($id, $cuid, $url, $user, $password, $schedule, $email));
     }

References $cuid, $db, $id, $msg, $password, $q, $user, checkmail(), delete_one(), and valid_schedule().

Referenced by update().

◆ cron_callback()

m_cron::cron_callback	(	$url,
		$content,
		$curl
	)

Callback function called by rolling_curl when a cron resulr has been received schedule it for next run and send the mail if needed.

Definition at line 253 of file m_cron.php.

                                                   {
         global $db, $L_FQDN;
         if (empty($url["id"])) {
             return; // not normal...
         }
         $id = intval($url["id"]);
  
         if ($curl["http_code"] == 200) {
             $ok = true;
         } else {
             $ok = false;
         }
         if (isset($url["email"]) && $url["email"] && $content) {
             if (!mail($url["email"], "AlternC Cron #$id - Report " . date("r"), "Please find below the stdout content produced by your cron task.\n------------------------------------------------------------\n\n" . $content, "From: postmaster@$L_FQDN")) {
                 echo "Error sending mail for cron #$id to address '" . $url["email"] . "'\n";
             }
         }
         // now schedule it for next run:
         $db->query("UPDATE cron SET next_execution=FROM_UNIXTIME( UNIX_TIMESTAMP(NOW()) + schedule * 60) WHERE id= ?", array($id));
     }

References $content, $db, $id, and $ok.

◆ delete_one()

m_cron::delete_one ( $id )

delete a crontab

Parameters

$id	the id of the crontab to delete

Returns: boolean TRUE if the crontab has been deleted

Definition at line 108 of file m_cron.php.

                              {
         global $db, $msg, $cuid;
         $msg->log("cron", "delete_one");
         return $db->query("DELETE FROM cron WHERE id= ? AND uid= ? LIMIT 1;", array(intval($id), $cuid));
     }

References $cuid, $db, $id, and $msg.

Referenced by _update_one().

◆ execute_cron()

m_cron::execute_cron ( )

Execute the required crontab of AlternC users this function EXIT at the end.

Definition at line 208 of file m_cron.php.

                             {
         global $db,$msg;
  
         $msg->debug("cron", "execute_cron");
         if (!isset($GLOBALS["DEBUG"])) {
             $GLOBALS["DEBUG"] = false;
         }
         $db->query("SELECT id, url, email, schedule, user, password FROM cron WHERE next_execution <= NOW();");
         $urllist = array();
  
         while ($db->next_record()) {
             $db->Record["url"] = urldecode($db->Record["url"]);
             $db->Record["user"] = urldecode($db->Record["user"]);
             $db->Record["email"] = urldecode($db->Record["email"]);
             $db->Record["password"] = urldecode($db->Record["password"]);
  
             // we support only http or https schemes:
             if (substr($db->Record["url"], 0, 7) == "http://" || substr($db->Record["url"], 0, 8) == "https://") {
                 $u = array(
                     "url" => $db->Record["url"],
                     "id" => $db->Record["id"], "email" => $db->Record["email"],
                 );
  
                 if ($db->Record["user"] && $db->Record["password"]) {
                     $u["login"] = $db->Record["user"];
                     $u["password"] = $db->Record["password"];
                 }
                 if ($GLOBALS["DEBUG"])
                     echo "Will run cron :\n" . print_r($u, true) . "\n";
                 $urllist[] = $u;
             }
  
             if (empty($urllist)) { // nothing to do : 
                 exit(0);
             }
         }
         // cron_callback($url, $content, $curlobj) will be called at the end of each http call.
         $this->rolling_curl($urllist, array("m_cron", "cron_callback"));
     }

References $db, $msg, exit, and rolling_curl().

◆ hook_menu()

m_cron::hook_menu ( )

Hook called by menu class to add menu to the left panel.

Definition at line 70 of file m_cron.php.

                          {
         $obj = array(
             'title' => _("Scheduled tasks"),
             'link' => 'cron.php',
             'pos' => 120,
         );
  
         return $obj;
     }

◆ hook_quota_get()

m_cron::hook_quota_get ( )

hook for quota computation

Definition at line 192 of file m_cron.php.

                               {
         global $cuid, $db, $msg;
         $msg->debug("cron", "alternc_get_quota");
         $q = Array("name" => "cron", "description" => _("Scheduled tasks"), "used" => 0);
         $db->query("select count(*) as cnt from cron where uid = ? ;", array($cuid));
         if ($db->next_record()) {
             $q['used'] = $db->f('cnt');
         }
         return $q;
     }

References $cuid, $db, $msg, and $q.

◆ lst_cron()

m_cron::lst_cron ( )

List the crontab for the current user.

Returns: array an hash for each crontab.

Definition at line 48 of file m_cron.php.

                         {
         global $cuid, $db, $msg;
         $msg->debug("cron", "lst_cron");
         $db->query("SELECT * FROM cron WHERE uid = ? ORDER BY url;", array($cuid));
         $r = Array();
         while ($db->next_record()) {
             $tmp = Array();
             $tmp['id'] = $db->f('id');
             $tmp['url'] = urldecode($db->f('url'));
             $tmp['user'] = urldecode($db->f('user'));
             $tmp['password'] = urldecode($db->f('password'));
             $tmp['schedule'] = $db->f('schedule');
             $tmp['email'] = urldecode($db->f('email'));
             $tmp['next_execution'] = $db->f('next_execution');
             $r[] = $tmp;
         }
         return $r;
     }

References $cuid, $db, $msg, and $r.

◆ rolling_curl()

m_cron::rolling_curl	(	$urls,
		$callback,
		$custom_options = `null`
	)

Launch parallel (using MAX_SOCKETS sockets maximum) retrieval of URL using CURL.

Parameters

$urls	array of associative array, each having the following keys : url = url to get (of the form http[s]://login:password@host/path/file?querystring ) login & password = if set, tell the login and password to use as simple HTTP AUTH. any other key will be sent as it is to the callback function
$callback	function called for each request when completing. First argument is the $url object, second is the content (output) third is the info structure from curl for the returned page. 200 for OK, 403 for AUTH FAILED, 0 for timeout, dump it to know it ;) this function should return as soon as possible to allow other curl calls to complete properly.
$cursom_options	array of custom CURL options for all transfers

Definition at line 287 of file m_cron.php.

                                                                     {
         // make sure the rolling window isn't greater than the # of urls
         if (!isset($GLOBALS["DEBUG"]))
             $GLOBALS["DEBUG"] = false;
         $rolling_window = m_cron::MAX_SOCKETS;
         $rolling_window = (count($urls) < $rolling_window) ? count($urls) : $rolling_window;
  
         $master = curl_multi_init();
  
         // add additional curl options here
         $std_options = array(CURLOPT_RETURNTRANSFER => true,
         CURLOPT_FOLLOWLOCATION => false,
         CURLOPT_CONNECTTIMEOUT => 5,
         CURLOPT_TIMEOUT => 240, // 4 minutes timeout for a page
         CURLOPT_USERAGENT => "AlternC (Cron Daemon)",
         CURLOPT_MAXREDIRS => 0);
  
         if ($GLOBALS["DEBUG"]) {
             $std_options[CURLOPT_VERBOSE] = true;
         }
         $options = ($custom_options) ? ($std_options + $custom_options) : $std_options;
  
         // start the first batch of requests
         for ($i = 0; $i < $rolling_window; $i++) {
             $ch = curl_init();
             $options[CURLOPT_URL] = $urls[$i]["url"];
             if ($GLOBALS["DEBUG"]) {
                 echo "URL: " . $urls[$i]["url"] . "\n";
             }
             curl_setopt_array($ch, $options);
             // Handle custom cafile for some https url
             if (strtolower(substr($options[CURLOPT_URL], 0, 5)) == "https") {
                 curl_setopt($ch, CURLOPT_CAINFO, m_cron::DEFAULT_CAFILE);
                 if ($GLOBALS["DEBUG"]) {
                     echo "cainfo set to DEFAULT\n";
                 }
             }
             if (isset($urls[$i]["login"]) && isset($urls[$i]["password"])) { // set basic http authentication
                 curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
                 curl_setopt($ch, CURLOPT_USERPWD, $urls[$i]["login"] . ":" . $urls[$i]["password"]);
                 if ($GLOBALS["DEBUG"]) {
                     echo "set basic auth\n";
                 }
             }
             curl_multi_add_handle($master, $ch);
         }
  
         do {
             while (($execrun = curl_multi_exec($master, $running)) == CURLM_CALL_MULTI_PERFORM);
             if ($execrun != CURLM_OK) {
                 break;
             }
             // a request was just completed -- find out which one
             while ($done = curl_multi_info_read($master)) {
                 $info = curl_getinfo($done['handle']);
                 // TODO : since ssl_verify_result is buggy, if we have [header_size] => 0  && [request_size] => 0 && [http_code] => 0, AND https, we can pretend the SSL certificate is buggy.
                 if ($GLOBALS["DEBUG"]) {
                     echo "Info for " . $done['handle'] . " \n";
                     print_r($info);
                 }
                 if ($info['http_code'] == 200) {
                     $output = curl_multi_getcontent($done['handle']);
                 } else {
                     // request failed.  add error handling.
                     $output = "";
                 }
                 // request terminated.  process output using the callback function.
                 // Pass the url array to the callback, so we need to search it
                 foreach ($urls as $url) {
                     if ($url["url"] == $info["url"]) {
                         call_user_func($callback, $url, $output, $info);
                         break;
                     }
                 }
  
                 // If there is more: start a new request
                 // (it's important to do this before removing the old one)
                 if ($i < count($urls)) {
                     $ch = curl_init();
                     $options[CURLOPT_URL] = $urls[$i++];  // increment i
                     curl_setopt_array($ch, $options);
                     if (strtolower(substr($options[CURLOPT_URL], 0, 5)) == "https") {
                         curl_setopt($ch, CURLOPT_CAINFO, m_cron::DEFAULT_CAFILE);
                         if ($GLOBALS["DEBUG"]) {
                             echo "cainfo set to DEFAULT\n";
                         }
                     }
                     if (isset($urls[$i]["login"]) && isset($urls[$i]["password"])) {  // set basic http authentication
                         curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
                         curl_setopt($ch, CURLOPT_USERPWD, urlencode($urls[$i]["login"]) . ":" . urlencode($urls[$i]["password"]));
                         if ($GLOBALS["DEBUG"]) {
                             echo "set basic auth\n";
                         }
                     }
                     curl_multi_add_handle($master, $ch);
                 }
                 // remove the curl handle that just completed
                 curl_multi_remove_handle($master, $done['handle']);
             }
         } while ($running);
  
         curl_multi_close($master);
         return true;
     }

References $i, $info, DEFAULT_CAFILE, and MAX_SOCKETS.

Referenced by execute_cron().

◆ schedule()

m_cron::schedule ( )

Definition at line 35 of file m_cron.php.

                         {
         return Array(
             Array('unit' => 1440, 'name' => _("Daily")),
             Array('unit' => 60, 'name' => _("Hour")),
             Array('unit' => 30, 'name' => _("Half Hour")),
         );
     }

Referenced by valid_schedule().

◆ update()

m_cron::update ( $arr )

update the crontab

Parameters

$arr	array the crontab information, including its ID

Returns: boolean TRUE if the crontab has been edited

Definition at line 86 of file m_cron.php.

                           {
         $ok = true;
         foreach ($arr as $a) {
             if (!isset($a['id'])) {
                 $a['id'] = null;
             }
             if (empty($a['url']) && is_null($a['id'])) {
                 continue;
             }
             if (!$this->_update_one($a['url'], $a['user'], $a['password'], $a['email'], $a['schedule'], $a['id'])) {
                 $ok = false;
             }
         }
         return $ok;
     }

References $ok, and _update_one().

◆ valid_schedule()

m_cron::valid_schedule ( $s )

validate a crontab schedule

Parameters

$s	array schedule paramters

Returns: boolean TRUE if the schedule is valid

Definition at line 174 of file m_cron.php.

                                 {
         $s2 = intval($s);
         if ($s2 != $s) {
             return false;
         }
         $r = false;
         foreach ($this->schedule() as $cs) {
             if ($cs['unit'] == $s) {
                 return true;
             }
         }
         return $r;
     }

References $r, and schedule().

Referenced by _update_one().

Member Data Documentation

◆ DEFAULT_CAFILE

const m_cron::DEFAULT_CAFILE = "/etc/ssl/certs/ca-certificates.crt"

Definition at line 29 of file m_cron.php.

Referenced by rolling_curl().

◆ MAX_SOCKETS

const m_cron::MAX_SOCKETS = 8

Definition at line 28 of file m_cron.php.

Referenced by rolling_curl().

The documentation for this class was generated from the following file:

bureau/class/m_cron.php

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ _update_one()

◆ cron_callback()

◆ delete_one()

◆ execute_cron()

◆ hook_menu()

◆ hook_quota_get()

◆ lst_cron()

◆ rolling_curl()

◆ schedule()

◆ update()

◆ valid_schedule()

Member Data Documentation

◆ DEFAULT_CAFILE

◆ MAX_SOCKETS