report.php File Reference

Send a status report to all users via e-mail. More...

Go to the source code of this file.

Functions
	report ($smarty, $INPUT, $db)
	Send a status report to all users via e-mail.

---

Detailed Description

Send a status report to all users via e-mail.

To set up automatic nightly status reports, you need a utility like curl(1) or wget(1). Create a cron job that runs a command like this:

 curl http://yourserver/semapp/action.php?action=report 

This will make action.php invoke the report() function. Alternatively, status reports can be triggered manually via the administrator's web interface.

Definition in file report.php.

---

Function Documentation

report	(	$	smarty,
		$	INPUT,
		$	db
	)

Send a status report to all users via e-mail.

Parameters:

	$smarty	-- a Smarty handle
	$INPUT	-- input data (currently unused)
	$db	-- a database handle

This function creates and sends an e-mail status report message to all users. These status reports contain details on changes in the document collections, etc.. Reports are role-specific, e.g. a "normal" user gets a different report than a librarian or an administrator.

The message report is created via Smarty, using the template file msg_report.tpl.

Definition at line 40 of file report.php.

References $actions_info, $item_info, $validation_info, send_email(), and sql_query().

                                      {

global $_SESSION, $default_role_id, $default_location_id, $debug_level;
global $actions_info, $item_info, $validation_info;

# default parameters 
$default = array(
);      

## check user input (basic)

# $INPUT = array_merge($default, $_GET, $_POST);
$INPUT = array_merge($default, $INPUT);

$now = strftime("%Y-%m-%d %H:%M:%S");


$param = array ( "tables" => "user,role,state,degree", 
                 "cond" => "user.state_id = state.id  AND 
                            user.role_id = role.id and
                            user.degree_id = degree.id", 

                "columns" => "user.*,degree.description AS degree_description,role.name AS role_name, state.name AS state_name",
                 "order" => "user.surname,user.forename,user.sex,degree_description" 
);

$users = sql_query('select', $param, $db);


$param = array ( 
        "tables" => "document,doc_type,state,collection,timestamp", 
        "cond" => "document.state_id = state.id AND collection.id = document.collection_id AND document.last_state_change >= timestamp.time AND timestamp.name='report'  AND doc_type.id = document.doc_type_id AND doc_type.for_loan != 0", 
         "columns" => "document.*, state.name AS state_name, collection.user_id AS user_id, collection.title AS collection_title",
);

$docs = sql_query('select', $param, $db);

$param = array ( 
        "tables" => "state,collection,timestamp", 
        "cond" => "collection.state_id = state.id AND collection.last_state_change >= timestamp.time AND timestamp.name='report'", 
         "columns" => "state.name AS state_name, collection.*",
);

$collections = sql_query('select', $param, $db);


$report_info = array();


foreach ($users as $u) {

        $uid = $u['id'];

        if ($u['state_name'] != "active") {     
                continue;
        }


        $report_info[$uid]['user_info'] = $u;

        ## documents

        foreach ($docs as $d) {

                $doc_state = $d['state_name'];

                $key = $u['role_name'] . "-" . $doc_state;

                switch($key) {

                case "staff-new":
                case "staff-obsolete":
                        $report_info[$uid]['doc'][$doc_state][] = $d;

                        break;

                case "edit-active":
                case "edit-inactive":

                        if ($uid == $d['user_id']) {
                                $report_info[$uid]['doc'][$doc_state][] = $d;
                        }
                        break;

                }

        }

        ## collections

        foreach ($collections as $c) {

                $coll_state = $c['state_name'];

                $key = $u['role_name'] . "-" . $coll_state;

                switch($key) {
                case "edit-obsolete":
                case "edit-inactive":
                        if ($c['user_id'] == $uid) {
                                $report_info[$uid]['coll'][$coll_state][] = $c;
                        }
                        break;
                }
        }

        ## users

        foreach ($users as $u2) {
        
                $user_state = $u2['state_name'];

                $key = $u['role_name'] . "-" . $user_state;

                switch($key) {
                case "admin-new":
                        $report_info[$uid]['user'][$user_state][] = $u2;
                        break;
                }
        }


}

foreach ($report_info as $r) {
        # send email report to user


        if (    (!isset($r['doc'])) and 
                (!isset($r['coll']))  and 
                (!isset($r['user'])) 
            ) {
                continue;
        }

        $tpl_vars = array();
        $tpl_vars = $r;

        $email_to = $r['user_info']['degree_name'] . " ";
        $email_to .= $r['user_info']['forename'] . " ";
        $email_to .= $r['user_info']['surname'] . " ";


        #debugging
        # $email_to .= "<mb@biblio.tu-bs.de>";

        $email_to .= "<" . $r['user_info']['email'] . ">";

        send_email($smarty,'msg_status.tpl',$tpl_vars, $email_to);

}

# update timestamp

$param = array ( 
        "tables" => "timestamp", 
        "cond" => "name = 'report'", 
        "data" => array ("time" => $now ),
);

sql_query('update', $param, $db);

}

Here is the call graph for this function:

---