This class manage actions to be performed on the file system on behalf of alternc Classes It primary use is to store the actions to be performed ( creating file or folder, deleting, setting permissions etc..) in the action sql table. More...

Public Member Functions
	do_action ()
	Tell the incron that an action should be performed. More...

	create_file ($file, $content="", $user="root")
	Plans a file creation. More...

	chmod ($filename, $perms, $user="root")
	Plans the a chmod on file or dir. More...

	create_dir ($dir, $user="root")
	Plans the creation of a dir. More...

	fix_user ($uid, $user="root")
	Plans a perms fix upon user creation. More...

	fix_dir ($dir, $user="root")
	Plans a dir permission fix. More...

	fix_file ($file, $user="root")
	Plans a file permission fix. More...

	del ($dir, $user="root")
	function to delete file / folder More...

	move ($src, $dst, $user="root")
	function returning the first not locked line of the action table More...

	archive ($archive, $dir="html")
	function archiving a directory ( upon account deletion ) More...

	set ($type, $user, $parameters)
	function inserting the action in the sql table More...

	get_old ()
	This seems to be unused ? More...

	purge ($all=null)

	get_action ()
	function returning the first not locked line of the action table More...

	begin ($id)
	function locking an entry while it is being executed by the action script More...

	finish ($id, $return=0)
	function locking an entry while it is being executed by the action script More...

	reset_job ($id)

	get_job ()
	Returns a list of actions marked as executable and ready for execution. More...

	cancel ($id)
	function locking an entry while it is being executed by the action script More...

Detailed Description

This class manage actions to be performed on the file system on behalf of alternc Classes It primary use is to store the actions to be performed ( creating file or folder, deleting, setting permissions etc..) in the action sql table.

The script /usr/lib/alternc/do_actions.php handled by cron and incron is then used to perform those actions.

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

Definition at line 28 of file m_action.php.

Member Function Documentation

◆ archive()

m_action::archive	(	$archive,
		$dir = `"html"`
	)

function archiving a directory ( upon account deletion )

Parameters

	global	int $cuid
	global	m_mysql $db
	global	m_messages $msg
string	$archive	Directory to archive within the archive_del_data folder if set in variable sql table If archive_del_data is not set we delete the folder
string	$dir	sub_directory of the archive directory

Returns: boolean

Definition at line 158 of file m_action.php.

                                               {
         global $cuid, $db, $msg;
  
         $arch = variable_get('archive_del_data');
         if (empty($arch)) {
             $this->del($archive);
             return true;
         }
         $BACKUP_DIR = $arch;
         $db->query("select login from membres where uid= ?;", array($cuid));
         $db->next_record();
         if (!$db->Record["login"]) {
             $msg->raise("ERROR", "action", _("Login corresponding to $cuid not found"));
             return false;
         }
         $uidlogin = $cuid . "-" . $db->Record["login"];
  
         //The path will look like /<archive_del_data>/YYYY-MM/<uid>-<login>/<folder>
         $today = getdate();
         $dest = $BACKUP_DIR . '/' . $today["year"] . '-' . $today["mon"] . '/' . $uidlogin . '/' . $dir;
         $this->move($archive, $dest);
         return true;
     }

References $cuid, $db, $msg, del(), move(), and variable_get().

◆ begin()

m_action::begin ( $id )

function locking an entry while it is being executed by the action script

Parameters

	global	m_mysql $db
	global	m_messages $msg
int	$id

Returns: boolean

Definition at line 290 of file m_action.php.

                         {
         global $db, $msg;
         if (!$db->query("update actions set begin=now() where id= ? ;", array($id))) {
             $msg->raise("ERROR", "action", _("Error locking the action : $id"));
             return false;
         }
         return true;
     }

References $db, $id, and $msg.

◆ cancel()

m_action::cancel ( $id )

function locking an entry while it is being executed by the action script

Parameters

	global	m_mysql $db
int	$id

Returns: boolean

Definition at line 363 of file m_action.php.

                          {
         $this->finish($id, 666);
         return true;
     }

References $id, and finish().

◆ chmod()

m_action::chmod	(	$filename,
		$perms,
		$user = `"root"`
	)

Plans the a chmod on file or dir.

Parameters

string	$filename
int	$perms
string	$user

Returns: boolean

Definition at line 69 of file m_action.php.

                                                       {
         return $this->set('chmod', $user, array('filename' => $filename, "perms" => $perms));
     }

References $user.

◆ create_dir()

m_action::create_dir	(	$dir,
		$user = `"root"`
	)

Plans the creation of a dir.

Parameters

string	$dir
int	$user

Returns: boolean

Definition at line 81 of file m_action.php.

                                               {
         return $this->set('create_dir', $user, array('dir' => $dir));
     }

References $user.

◆ create_file()

m_action::create_file	(	$file,
		$content = `""`,
		$user = `"root"`
	)

Plans a file creation.

Parameters

string	$file
string	$content
int	$user

Returns: boolean

Definition at line 56 of file m_action.php.

                                                                {
         return $this->set('create_file', $user, array('file' => $file, 'content' => $content));
     }

References $content, and $user.

◆ del()

m_action::del	(	$dir,
		$user = `"root"`
	)

function to delete file / folder

Parameters

string	$dir
m_user	$user

Returns: boolean

Definition at line 128 of file m_action.php.

                                        {
         return $this->set('delete', $user, array('dir' => $dir));
     }

References $user.

Referenced by archive().

◆ do_action()

m_action::do_action ( )

Tell the incron that an action should be performed.

Parameters

global	m_messages $msg
global	string $L_INOTIFY_DO_ACTION

Returns: boolean

Definition at line 38 of file m_action.php.

                          {
         global $msg, $L_INOTIFY_DO_ACTION;
         $msg->log("action", "do_action");
         if (!@touch($L_INOTIFY_DO_ACTION)) {
             return FALSE;
         }
         return TRUE;
     }

References $msg.

Referenced by set().

◆ finish()

m_action::finish	(	$id,
		$return = `0`
	)

function locking an entry while it is being executed by the action script

Parameters

	global	m_mysql $db
	global	m_messages $msg
int	$id
integer	$return

Returns: boolean

Definition at line 309 of file m_action.php.

                                       {
         global $db, $msg;
         if (!$db->query("update actions set end=now(),status=? where id= ?;", array($return, $id))) {
             $msg->raise("ERROR", "action", _("Error unlocking the action : $id"));
             return false;
         }
         return true;
     }

References $db, $id, and $msg.

Referenced by cancel().

◆ fix_dir()

m_action::fix_dir	(	$dir,
		$user = `"root"`
	)

Plans a dir permission fix.

Parameters

string	$dir
m_user	$user

Returns: boolean

Definition at line 104 of file m_action.php.

                                            {
         return $this->set('fix_dir', $user, array('dir' => $dir));
     }

References $user.

◆ fix_file()

m_action::fix_file	(	$file,
		$user = `"root"`
	)

Plans a file permission fix.

Parameters

string	$file
m_user	$user

Returns: boolean

Definition at line 116 of file m_action.php.

                                              {
         return $this->set('fix_file', $user, array('file' => $file));
     }

References $user.

◆ fix_user()

m_action::fix_user	(	$uid,
		$user = `"root"`
	)

Plans a perms fix upon user creation.

Parameters

int	$uid
string	$user

Returns: boolean

Definition at line 92 of file m_action.php.

                                             {
         return $this->set('fix_user', $user, array('uid' => $uid));
     }

References $uid, and $user.

◆ get_action()

m_action::get_action ( )

function returning the first not locked line of the action table

Parameters

global m_mysql $db

Returns: boolean or array

Definition at line 268 of file m_action.php.

                           {
         global $db;
  
         $tab = array();
         $db->query('select * from actions where end = 0 and begin = 0 order by id limit 1;');
         if ($db->next_record()) {
             $tab[] = $db->Record;
             return $tab;
         } else {
             return false;
         }
     }

References $db, and $tab.

◆ get_job()

m_action::get_job ( )

Returns a list of actions marked as executable and ready for execution.

Parameters

global	m_mysql $db
global	m_messages $msg

Returns: boolean

Definition at line 343 of file m_action.php.

                        {
         global $db;
         $tab = array();
         $db->query("Select * from actions where begin !=0 and end = 0 ;");
         if ($db->next_record()) {
             $tab[] = $db->Record;
             return $tab;
         } else {
             return false;
         }
     }

References $db, and $tab.

◆ get_old()

m_action::get_old ( )

This seems to be unused ?

Parameters

global	m_messages $msg
global	m_mysql $db

Returns: boolean

Definition at line 226 of file m_action.php.

                        {
         global $msg, $db;
  
         $purge = "select * from actions where TO_DAYS(curdate()) - TO_DAYS(creation) > 2;";
         $result = $db->query($purge);
         if (!$result) {
             $msg->raise("ERROR", "action", _("Error selecting  old actions"));
             return false;
         }
         return $db->num_rows($result);
     }

References $db, and $msg.

◆ move()

m_action::move	(	$src,
		$dst,
		$user = `"root"`
	)

function returning the first not locked line of the action table

Parameters

string	$src
string	$dst
m_user	$user

Returns: boolean

Definition at line 141 of file m_action.php.

                                               {
         return $this->set('move', $user, array('src' => $src, 'dst' => $dst));
     }

References $user.

Referenced by archive().

◆ purge()

m_action::purge ( $all = null )

Parameters

	global	m_messages $msg
	global	m_mysql $db
type	$all

Returns: boolean|int The number of rows purged; False is there was an error

Definition at line 246 of file m_action.php.

                                 {
         global $msg, $db;
         if (is_null($all)) {
             $purge = "delete from actions where TO_DAYS(curdate()) - TO_DAYS(creation) > 2 and status = 0;";
         } else {
             $purge = "delete from actions where TO_DAYS(curdate()) - TO_DAYS(creation) > 2;";
         }
         $result = $db->query($purge);
         if (!$result) {
             $msg->raise("ERROR", "action", _("Error purging old actions"));
             return false;
         }
         return $db->num_rows($result);
     }

References $db, and $msg.

◆ reset_job()

m_action::reset_job ( $id )

Parameters

	global	m_mysql $db
	global	m_messages $msg
int	$id

Returns: boolean

Definition at line 326 of file m_action.php.

                             {
         global $db, $msg;
         if (!$db->query("update actions set end=0,begin=0,status='' where id= ?;", array($id))) {
             $msg->raise("ERROR", "action", _("Error unlocking the action : $id"));
             return false;
         }
         return true;
     }

References $db, $id, and $msg.

◆ set()

m_action::set	(	$type,
		$user,
		$parameters
	)

function inserting the action in the sql table

Parameters

	global	m_mysql $db
	global	m_messages $msg
string	$type
string \| integer	$user	wich user do we impersonate?
mixed	$parameters

Returns: boolean

Definition at line 193 of file m_action.php.

                                             {
         global $db, $msg;
         $msg->log("action", "set", $type);
         $serialized = serialize($parameters);
         $type = strtoupper($type);
         if (in_array($type, array('CHMOD',
         'CREATE_FILE', 
         'CREATE_DIR', 
         'MOVE', 
         'FIX_USER', 
         'FIX_FILE', 
         'FIX_DIR', 
         'DELETE'))) {
             $query = "INSERT INTO `actions` (type, parameters, creation, user) VALUES('$type', '$serialized', now(), '$user');";
         } else {
             return False;
         }
  
         if (!$db->query($query)) {
             $msg->raise("ERROR", "action", _("Error setting actions"));
             return false;
         }
         return $this->do_action();
     }

References $db, $msg, $query, and do_action().

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

bureau/class/m_action.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ archive()

◆ begin()

◆ cancel()

◆ chmod()

◆ create_dir()

◆ create_file()

◆ del()

◆ do_action()

◆ finish()

◆ fix_dir()

◆ fix_file()

◆ fix_user()

◆ get_action()

◆ get_job()

◆ get_old()

◆ move()

◆ purge()

◆ reset_job()

◆ set()