mod_item.php File Reference

Functions that perform status changes on items. More...

Go to the source code of this file.

Functions
	extend_loan ($coll_id, $db)
	Extend the loan period for a document collection.
	coll_set_state ($smarty, $collection_id, $states, $db)
	Perform a status change on the members of a document collection.
	set_item_state ($smarty, $INPUT, $db)
	Change the state of an item.
	expire ($smarty, $db)
	Expire a document collection.

---

Detailed Description

Functions that perform status changes on items.

Definition in file mod_item.php.

---

Function Documentation

coll_set_state	(	$	smarty,
		$	collection_id,
		$	states,
		$	db
	)

Perform a status change on the members of a document collection.

Parameters:

	$smarty	-- Smarty template engine handle
	$db	-- SQL database handle
	$collection_id	-- id of the document collection
	$states	-- an associative array mapping original states to target states for items in this collection

This is a helper function for the set_item_state() function. It's purpose is to loop through all documents in a collection, and to apply the status changes described in the $states[] table.

Definition at line 59 of file mod_item.php.

References sql_query().

Referenced by set_item_state().

                                                                {

        # set state of documents in collection
        $param = array ( 

                 "tables" => "document,state,doc_type",
                 "columns" => "document.*, state.name AS state_name, doc_type.name as doc_type_name",
                 "cond" => "document.collection_id = " . $collection_id . 
                           " AND document.state_id = state.id AND document.doc_type_id = doc_type.id",

                );
        

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

        $param = array ( "table" => "document");

        foreach ($docs as $d) {

                $param['id'] = $d['id'];

                $cur_state   = $d['state_name']; 
                $cur_doctype = $d['doc_type_name']; 

                $keys = array(  
                        $cur_doctype . '-' . $cur_state,
                        $cur_state,
                        'DEFAULT'
                );

                # print_r($keys);

                unset($param['state']);

                foreach ($keys as $k) {
                        if  (isset($states[$k])) {
                                $param['state'] = $states[$k];
                                break;
                        }
                }

                # print_r($param);
                if (isset($param['state'])) {
                        sql_query('set_state', $param, $db);
                }
        }

}

Here is the call graph for this function:

expire	(	$	smarty,
		$	db
	)

Expire a document collection.

Parameters:

	$smarty	- Smarty handle
	$db	-- SQL database handle

This function is central to the "expiry" mechanism for document collections. It should be called ever so often to allow stale document collections to expire. For example, whenever the index page (index.php) is visited, a call to expiry() is made.

This function checks for document collections whose expiry date has been met. These collections are suspended (state is set to 'obsolete').

The owner of the collection will be informed on the next run of the nighty status report (see report() for details).

The owner can then choose to extend the loan period via the Web interface. In this case, the collection's status is changed back to "active", and a new expiry date is set.

After a grace period of 14 days, collections that still have 'obsolete' status are dissolved. This means that the status of the collection is set to 'inactive', and that the status of the documents in the collection also changes.

• Online documents and URLs change to "inactive" so that they are inaccessible.

• Books and articles change to "obsolete". This triggers the library staff to remove them from the shelves in the library, because they show up as "not needed anymore" in their web interface.

  Afterwards, they acknowledge the removal via their web interface, which causes the status to change to "inactive".

In the end, the collection itself as well as any of it's contents has reached the status "inactive". In this "final" state, there are two possibilities:

• An owner can "reactivate" the collection, changing the status back to "active". Any items in the collection can also be re-activated.
• The owner can "delete" the collection (and it's contents).

Definition at line 298 of file mod_item.php.

References set_item_state(), and sql_query().

Referenced by do_action(), show_collection(), and show_index().

                              {

        $param = array (
                "tables" => "collection as c,state as s" ,
                "columns" => "c.id" ,
                 cond => "c.state_id = s.id AND 
                          s.name = 'active' AND 
                          c.expiry_date <= NOW()",
        );

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

        $input = array ("item" => "collection", "state" => "obsolete" );

        foreach ($colls as $c) {
                $input['id'] = $c['id']; 
                set_item_state($smarty, $input, $db);
        }


        $param = array (
                "tables" => "collection AS c,state AS s" ,
                "columns" => "c.id AS id",  
                 cond => "(c.state_id = s.id) AND 
                          (s.name = 'obsolete') AND 
                          DATE_ADD(c.expiry_date, INTERVAL 14 DAY) <= NOW()"
        );

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

        $input = array ("item" => "collection", "state" => "inactive" );

        foreach ($colls as $c) {
                $input['id'] = $c['id']; 
                set_item_state($smarty, $input, $db);
        }
}

Here is the call graph for this function:

extend_loan	(	$	coll_id,
		$	db
	)

Extend the loan period for a document collection.

Parameters:

	$coll_id	- document collection id
	$db	-- SQL database handle

This function will extend the loan period of an (already expired) document collection. The new expiry date is determined with the get_new_expiry_date() helper function.

Definition at line 20 of file mod_item.php.

References get_new_expiry_date(), and sql_query().

Referenced by set_item_state().

                                    {

        # $param = array (
        #       "tables" => "collection",
        #       "cond" => "expiry_date <= NOW() AND id = " . $coll_id
        # );
        # 
        # $ans = sql_query('select', $param, $db);
        #
        # # not expired? --> do nothing
        #
        # if (empty($ans)) { 
        #       return;
        # }

        # set a new expiry date

        $param = array (
                "tables" => "collection",
                "id" => $coll_id,
                "data" => array ("expiry_date" => get_new_expiry_date()) 
        );

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

}

Here is the call graph for this function:

set_item_state	(	$	smarty,
		$	INPUT,
		$	db
	)

Change the state of an item.

Parameters:

	$smarty	-- Smarty handle
	$db	-- SQL database handle
	$INPUT['item']	-- item type
	$INPUT['id']	-- item id
	$INPUT['state']	-- new state

Note:

Certain state changes have side effects. For instance, changing a new user account to "open" causes a password to be assigned and mailed that the user, and to promote the user to status "active".

Also, changing a collection's status to inactive (or back to active) also affects the status of all documents inside the collection. See expire() for an explanation for this behaviour.

Definition at line 127 of file mod_item.php.

References $validation_info, coll_set_state(), do_template(), extend_loan(), get_item_owner(), get_new_expiry_date(), send_email(), set_random_pw(), and sql_query().

Referenced by expire().

                                              {

global $_SESSION, $validation_info;

$default = array(
);

## check user input 

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

$INPUT = array_merge($default, $INPUT);

# $errors = check_input($INPUT, $validation_info); 


#if ($debug_level > 10) {
#        print "<hr><pre>Input: ";
#       print_r($INPUT);
#       print "</pre><hr>";
#}

#if (!empty($errors)) {
#       user_error("Missing or malformed input parameter(s): " . join($errors, ", "),
#               E_USER_ERROR); 
#}

$item_tables = array(
        "DEFAULT" => "document", 
        "collection" => "collection", 
        "user"    => "user", 
);


$action = $INPUT['item'] . "-" . $INPUT['state'];

## special cases

switch($action) {

        case "collection-inactive": 

                $new_states = array(
                        "DEFAULT"       => "inactive",
                        "open"          => "obsolete",
                        "active"        => "obsolete",
                        "obsolete"      => "obsolete",
                        "file-active"    => "inactive",
                        "url-active"    => "inactive",
                );

                coll_set_state($smarty, $INPUT['id'], $new_states, $db);

        break;

        case "collection-active": 

                # $new_states = array (
                #       "file-inactive"    => "active",
                #       "url-inactive"    => "active",
                # );

                coll_set_state($smarty, $INPUT['id'], $new_states, $db);
                extend_loan($INPUT['id'], $db); 

        break;


        case "user-open":

                # create random password and mail it to the user
         
                $passwd = set_random_pw($INPUT['id'], $db);

                $user = get_item_owner("user", $INPUT['id'], $db);
                        
                $email_to = $user['degree_name'] . " ";
                $email_to .= $user['forename'] . " ";
                $email_to .= $user['surname'] . " ";
                $email_to .= "<" . $user['email'] . ">";

                $tpl_vars = array();
                $tpl_vars['user_info'] = $user; 
                $tpl_vars['user_info']['password'] = $passwd;   

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

                # set state to active
                $INPUT['state'] = "active";

        break;
}

$tbl = $item_tables['DEFAULT'];

if (isset($item_tables[$INPUT['item']])) {
        $tbl = $item_tables[$INPUT['item']];
}

$param = array ( "table" => $tbl,
                 "state" => $INPUT['state'],
                 "id" => $INPUT['id'],
);

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

if ($action == "collection-active") {
        # show message for user

        $tpl_vars = array (
                "expiry_date" => get_new_expiry_date() ,
                "id" => $INPUT['id']
        );

        do_template($smarty,'extend_loan.tpl', $tpl_vars);
        exit(0);
}

}

Here is the call graph for this function:

---