[civicrm-core.git] / CRM / Core / Page / Basic.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.4                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2013                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2013
 * $Id$
 *
 */


abstract class CRM_Core_Page_Basic extends CRM_Core_Page {

  protected $_action;

  /**
   * define all the abstract functions here
   */

  /**
   * name of the BAO to perform various DB manipulations
   *
   * @return string
   * @access public
   */

  abstract function getBAOName();

  /**
   * an array of action links
   *
   * @return array (reference)
   * @access public
   */
  abstract function &links();

  /**
   * name of the edit form class
   *
   * @return string
   * @access public
   */
  abstract function editForm();

  /**
   * name of the form
   *
   * @return string
   * @access public
   */
  abstract function editName();

  /**
   * userContext to pop back to
   *
   * @param int $mode mode that we are in
   *
   * @return string
   * @access public
   */
  abstract function userContext($mode = NULL);

  /**
   * function to get userContext params
   *
   * @param int $mode mode that we are in
   *
   * @return string
   * @access public
   */
  function userContextParams($mode = NULL) {
    return 'reset=1&action=browse';
  }

  /**
   * allow objects to be added based on permission
   *
   * @param int $id   the id of the object
   * @param int $name the name or title of the object
   *
   * @return string   permission value if permission is granted, else null
   * @access public
   */
  public function checkPermission($id, $name) {
    return CRM_Core_Permission::EDIT;
  }

  /**
   * allows the derived class to add some more state variables to
   * the controller. By default does nothing, and hence is abstract
   *
   * @param CRM_Core_Controller $controller the controller object
   *
   * @return void
   * @access public
   */
  function addValues($controller) {}

  /**
   * class constructor
   *
   * @param string $title title of the page
   * @param int    $mode  mode of the page
   *
   * @return CRM_Core_Page
   */
  function __construct($title = NULL, $mode = NULL) {
    parent::__construct($title, $mode);
  }

  /**
   * Run the basic page (run essentially starts execution for that page).
   *
   * @return void
   */
  function run() {
    // CRM-9034
    // dont see args or pageArgs being used, so we should
    // consider eliminating them in a future version
    $n        = func_num_args();
    $args     = ($n > 0) ? func_get_arg(0) : NULL;
    $pageArgs = ($n > 1) ? func_get_arg(1) : NULL;
    $sort     = ($n > 2) ? func_get_arg(2) : NULL;
    // what action do we want to perform ? (store it for smarty too.. :)

    $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
    $this->assign('action', $this->_action);

    // get 'id' if present
    $id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);

    require_once (str_replace('_', DIRECTORY_SEPARATOR, $this->getBAOName()) . ".php");

    if ($id) {
      if (!$this->checkPermission($id, NULL)) {
        CRM_Core_Error::fatal(ts('You do not have permission to make changes to the record'));
      }
    }

    if ($this->_action &
      (CRM_Core_Action::VIEW |
        CRM_Core_Action::ADD |
        CRM_Core_Action::UPDATE |
        CRM_Core_Action::COPY |
        CRM_Core_Action::ENABLE |
        CRM_Core_Action::DISABLE |
        CRM_Core_Action::DELETE
      )
    ) {
      // use edit form for view, add or update or delete
      $this->edit($this->_action, $id);
    }
    else {
      // if no action or browse
      $this->browse(NULL, $sort);
    }

    return parent::run();
  }

  function superRun() {
    return parent::run();
  }

  /**
   * browse all entities.
   *
   * @param int $action
   *
   * @return void
   * @access public
   */
  function browse() {
    $n      = func_num_args();
    $action = ($n > 0) ? func_get_arg(0) : NULL;
    $sort   = ($n > 0) ? func_get_arg(1) : NULL;
    $links  = &$this->links();
    if ($action == NULL) {
      if (!empty($links)) {
        $action = array_sum(array_keys($links));
      }
    }
    if ($action & CRM_Core_Action::DISABLE) {
      $action -= CRM_Core_Action::DISABLE;
    }
    if ($action & CRM_Core_Action::ENABLE) {
      $action -= CRM_Core_Action::ENABLE;
    }
    $baoString = $this->getBAOName();
    $object = new $baoString();

    $values = array();

    /*
         * lets make sure we get the stuff sorted by name if it exists
         */

    $fields = &$object->fields();
    $key = '';
    if (!empty($fields['title'])) {
      $key = 'title';
    }
    elseif (!empty($fields['label'])) {
      $key = 'label';
    }
    elseif (!empty($fields['name'])) {
      $key = 'name';
    }

    if (trim($sort)) {
      $object->orderBy($sort);
    }
    elseif ($key) {
      $object->orderBy($key . ' asc');
    }


    // find all objects
    $object->find();
    while ($object->fetch()) {
      if (!isset($object->mapping_type_id) ||
        // "1 for Search Builder"
        $object->mapping_type_id != 1
      ) {
        $permission = CRM_Core_Permission::EDIT;
        if ($key) {
          $permission = $this->checkPermission($object->id, $object->$key);
        }
        if ($permission) {
          $values[$object->id] = array();
          CRM_Core_DAO::storeValues($object, $values[$object->id]);

          CRM_Contact_DAO_RelationshipType::addDisplayEnums($values[$object->id]);

          // populate action links
          $this->action($object, $action, $values[$object->id], $links, $permission);

          if (isset($object->mapping_type_id)) {
            $mappintTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Mapping', 'mapping_type_id');
            $values[$object->id]['mapping_type'] = $mappintTypes[$object->mapping_type_id];
          }
        }
      }
    }
    $this->assign('rows', $values);
  }

  /**
   * Given an object, get the actions that can be associated with this
   * object. Check the is_active and is_required flags to display valid
   * actions
   *
   * @param CRM_Core_DAO $object the object being considered
   * @param int     $action the base set of actions
   * @param array   $values the array of values that we send to the template
   * @param array   $links  the array of links
   * @param string  $permission the permission assigned to this object
   *
   * @return void
   * @access private
   */
  function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
    $values['class'] = '';
    $newAction       = $action;
    $hasDelete       = $hasDisable = TRUE;

    if (!empty($values['name']) && in_array($values['name'], array(
      'encounter_medium', 'case_type', 'case_status'))) {
      static $caseCount = NULL;
      if (!isset($caseCount)) {
        $caseCount = CRM_Case_BAO_Case::caseCount(NULL, FALSE);
      }
      if ($caseCount > 0) {
        $hasDelete = $hasDisable = FALSE;
      }
    }

    if (!$forceAction) {
      if (array_key_exists('is_reserved', $object) && $object->is_reserved) {
        $values['class'] = 'reserved';
        // check if object is relationship type
        $object_type = get_class($object);

        $exceptions = array(
          'CRM_Contact_BAO_RelationshipType',
          'CRM_Core_BAO_LocationType',
          'CRM_Badge_BAO_Layout',
        );

        if (in_array($object_type, $exceptions)) {
          $newAction = CRM_Core_Action::VIEW + CRM_Core_Action::UPDATE;
        }
        else {
          $newAction = 0;
          $values['action'] = '';
          return;
        }
      }
      else {
        if (array_key_exists('is_active', $object)) {
          if ($object->is_active) {
            if ($hasDisable) {
              $newAction += CRM_Core_Action::DISABLE;
            }
          }
          else {
            $newAction += CRM_Core_Action::ENABLE;
          }
        }
      }
    }

    //CRM-4418, handling edit and delete separately.
    $permissions = array($permission);
    if ($hasDelete && ($permission == CRM_Core_Permission::EDIT)) {
      //previously delete was subset of edit
      //so for consistency lets grant delete also.
      $permissions[] = CRM_Core_Permission::DELETE;
    }

    // make sure we only allow those actions that the user is permissioned for
    $newAction = $newAction & CRM_Core_Action::mask($permissions);

    $values['action'] = CRM_Core_Action::formLink($links, $newAction, array('id' => $object->id));
  }

  /**
   * Edit this entity.
   *
   * @param int $mode - what mode for the form ?
   * @param int $id - id of the entity (for update, view operations)
   *
   * @return void
   */
  function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
    $controller = new CRM_Core_Controller_Simple($this->editForm(),
      $this->editName(),
      $mode,
      $imageUpload
    );

    // set the userContext stack
    if ($pushUserContext) {
      $session = CRM_Core_Session::singleton();
      $session->pushUserContext(CRM_Utils_System::url($this->userContext($mode), $this->userContextParams($mode)));
    }
    if ($id !== NULL) {
      $controller->set('id', $id);
    }
    $controller->set('BAOName', $this->getBAOName());
    $this->addValues($controller);
    $controller->setEmbedded(TRUE);
    $controller->process();
    $controller->run();
  }
}
Commit	Line	Data
6a488035 TO	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
232624b1	4	\| CiviCRM version 4.4 \|
6a488035 TO	5	+--------------------------------------------------------------------+
	6	\| Copyright CiviCRM LLC (c) 2004-2013 \|
	7	+--------------------------------------------------------------------+
	8	\| This file is a part of CiviCRM. \|
	9	\| \|
	10	\| CiviCRM is free software; you can copy, modify, and distribute it \|
	11	\| under the terms of the GNU Affero General Public License \|
	12	\| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. \|
	13	\| \|
	14	\| CiviCRM is distributed in the hope that it will be useful, but \|
	15	\| WITHOUT ANY WARRANTY; without even the implied warranty of \|
	16	\| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. \|
	17	\| See the GNU Affero General Public License for more details. \|
	18	\| \|
	19	\| You should have received a copy of the GNU Affero General Public \|
	20	\| License and the CiviCRM Licensing Exception along \|
	21	\| with this program; if not, contact CiviCRM LLC \|
	22	\| at info[AT]civicrm[DOT]org. If you have questions about the \|
	23	\| GNU Affero General Public License or the licensing of CiviCRM, \|
	24	\| see the CiviCRM license FAQ at http://civicrm.org/licensing \|
	25	+--------------------------------------------------------------------+
	26	*/
	27
	28	/**
	29	*
	30	* @package CRM
	31	* @copyright CiviCRM LLC (c) 2004-2013
	32	* $Id$
	33	*
	34	*/
	35
	36
	37
	38
	39	abstract class CRM_Core_Page_Basic extends CRM_Core_Page {
	40
	41	protected $_action;
	42
	43	/**
	44	* define all the abstract functions here
	45	*/
	46
	47	/**
	48	* name of the BAO to perform various DB manipulations
	49	*
	50	* @return string
	51	* @access public
	52	*/
	53
	54	abstract function getBAOName();
	55
	56	/**
	57	* an array of action links
	58	*
	59	* @return array (reference)
	60	* @access public
	61	*/
	62	abstract function &links();
	63
	64	/**
	65	* name of the edit form class
	66	*
	67	* @return string
	68	* @access public
69	*/
70	abstract function editForm();
71
72	/**
73	* name of the form
74	*
75	* @return string
76	* @access public
77	*/
78	abstract function editName();
79
80	/**
81	* userContext to pop back to
82	*
83	* @param int $mode mode that we are in
84	*
85	* @return string
86	* @access public
87	*/
88	abstract function userContext($mode = NULL);
89
90	/**
91	* function to get userContext params
92	*
93	* @param int $mode mode that we are in
94	*
95	* @return string
96	* @access public
97	*/
98	function userContextParams($mode = NULL) {
99	return 'reset=1&action=browse';
100	}
101
102	/**
103	* allow objects to be added based on permission
104	*
105	* @param int $id the id of the object
106	* @param int $name the name or title of the object
107	*
108	* @return string permission value if permission is granted, else null
109	* @access public
110	*/
111	public function checkPermission($id, $name) {
112	return CRM_Core_Permission::EDIT;
113	}
114
115	/**
116	* allows the derived class to add some more state variables to
117	* the controller. By default does nothing, and hence is abstract
118	*
119	* @param CRM_Core_Controller $controller the controller object
120	*
121	* @return void
122	* @access public
123	*/
124	function addValues($controller) {}
125
126	/**
127	* class constructor
128	*
129	* @param string $title title of the page
130	* @param int $mode mode of the page
131	*
132	* @return CRM_Core_Page
133	*/
134	function __construct($title = NULL, $mode = NULL) {
135	parent::__construct($title, $mode);
136	}
137
138	/**
139	* Run the basic page (run essentially starts execution for that page).
140	*
141	* @return void
142	*/
143	function run() {
144	// CRM-9034
145	// dont see args or pageArgs being used, so we should
146	// consider eliminating them in a future version
147	$n = func_num_args();
148	$args = ($n > 0) ? func_get_arg(0) : NULL;
149	$pageArgs = ($n > 1) ? func_get_arg(1) : NULL;
150	$sort = ($n > 2) ? func_get_arg(2) : NULL;
151	// what action do we want to perform ? (store it for smarty too.. :)
152
153	$this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'browse');
154	$this->assign('action', $this->_action);
155
156	// get 'id' if present
157	$id = CRM_Utils_Request::retrieve('id', 'Positive', $this, FALSE, 0);
158
159	require_once (str_replace('_', DIRECTORY_SEPARATOR, $this->getBAOName()) . ".php");
160
161	if ($id) {
162	if (!$this->checkPermission($id, NULL)) {
163	CRM_Core_Error::fatal(ts('You do not have permission to make changes to the record'));
164	}
165	}
166
167	if ($this->_action &
168	(CRM_Core_Action::VIEW \|
169	CRM_Core_Action::ADD \|
170	CRM_Core_Action::UPDATE \|
171	CRM_Core_Action::COPY \|
172	CRM_Core_Action::ENABLE \|
173	CRM_Core_Action::DISABLE \|
174	CRM_Core_Action::DELETE
175	)
176	) {
177	// use edit form for view, add or update or delete
178	$this->edit($this->_action, $id);
179	}
180	else {
181	// if no action or browse
182	$this->browse(NULL, $sort);
183	}
184
185	return parent::run();
186	}
187
188	function superRun() {
189	return parent::run();
190	}
191
192	/**
193	* browse all entities.
194	*
195	* @param int $action
196	*
197	* @return void
198	* @access public
199	*/
200	function browse() {
201	$n = func_num_args();
202	$action = ($n > 0) ? func_get_arg(0) : NULL;
203	$sort = ($n > 0) ? func_get_arg(1) : NULL;
204	$links = &$this->links();
205	if ($action == NULL) {
206	if (!empty($links)) {
207	$action = array_sum(array_keys($links));
208	}
209	}
210	if ($action & CRM_Core_Action::DISABLE) {
211	$action -= CRM_Core_Action::DISABLE;
212	}
213	if ($action & CRM_Core_Action::ENABLE) {
214	$action -= CRM_Core_Action::ENABLE;
215	}
4d5c2eb5	216	$baoString = $this->getBAOName();
4d5c2eb5	217	$object = new $baoString();
6a488035 TO	218
	219	$values = array();
	220
	221	/*
	222	* lets make sure we get the stuff sorted by name if it exists
	223	*/
	224
	225	$fields = &$object->fields();
	226	$key = '';
a7488080	227	if (!empty($fields['title'])) {
6a488035 TO	228	$key = 'title';
6a488035 TO	229	}
a7488080	230	elseif (!empty($fields['label'])) {
6a488035 TO	231	$key = 'label';
6a488035 TO	232	}
a7488080	233	elseif (!empty($fields['name'])) {
6a488035 TO	234	$key = 'name';
	235	}
	236
	237	if (trim($sort)) {
	238	$object->orderBy($sort);
	239	}
	240	elseif ($key) {
	241	$object->orderBy($key . ' asc');
	242	}
	243
	244
	245	// find all objects
	246	$object->find();
	247	while ($object->fetch()) {
	248	if (!isset($object->mapping_type_id) \|\|
	249	// "1 for Search Builder"
	250	$object->mapping_type_id != 1
	251	) {
	252	$permission = CRM_Core_Permission::EDIT;
	253	if ($key) {
	254	$permission = $this->checkPermission($object->id, $object->$key);
	255	}
	256	if ($permission) {
	257	$values[$object->id] = array();
	258	CRM_Core_DAO::storeValues($object, $values[$object->id]);
	259
	260	CRM_Contact_DAO_RelationshipType::addDisplayEnums($values[$object->id]);
	261
	262	// populate action links
	263	$this->action($object, $action, $values[$object->id], $links, $permission);
	264
	265	if (isset($object->mapping_type_id)) {
cbf48754	266	$mappintTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Mapping', 'mapping_type_id');
6a488035 TO	267	$values[$object->id]['mapping_type'] = $mappintTypes[$object->mapping_type_id];
	268	}
	269	}
	270	}
	271	}
	272	$this->assign('rows', $values);
	273	}
	274
	275	/**
	276	* Given an object, get the actions that can be associated with this
	277	* object. Check the is_active and is_required flags to display valid
	278	* actions
	279	*
	280	* @param CRM_Core_DAO $object the object being considered
	281	* @param int $action the base set of actions
	282	* @param array $values the array of values that we send to the template
	283	* @param array $links the array of links
	284	* @param string $permission the permission assigned to this object
	285	*
	286	* @return void
	287	* @access private
	288	*/
	289	function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) {
	290	$values['class'] = '';
	291	$newAction = $action;
	292	$hasDelete = $hasDisable = TRUE;
	293
a7488080	294	if (!empty($values['name']) && in_array($values['name'], array(
6a488035 TO	295	'encounter_medium', 'case_type', 'case_status'))) {
	296	static $caseCount = NULL;
	297	if (!isset($caseCount)) {
	298	$caseCount = CRM_Case_BAO_Case::caseCount(NULL, FALSE);
	299	}
	300	if ($caseCount > 0) {
	301	$hasDelete = $hasDisable = FALSE;
	302	}
	303	}
	304
	305	if (!$forceAction) {
	306	if (array_key_exists('is_reserved', $object) && $object->is_reserved) {
	307	$values['class'] = 'reserved';
	308	// check if object is relationship type
	309	$object_type = get_class($object);
d2e138ee KJ	310
	311	$exceptions = array(
	312	'CRM_Contact_BAO_RelationshipType',
	313	'CRM_Core_BAO_LocationType',
	314	'CRM_Badge_BAO_Layout',
	315	);
	316
	317	if (in_array($object_type, $exceptions)) {
6a488035 TO	318	$newAction = CRM_Core_Action::VIEW + CRM_Core_Action::UPDATE;
	319	}
	320	else {
	321	$newAction = 0;
	322	$values['action'] = '';
	323	return;
	324	}
	325	}
	326	else {
	327	if (array_key_exists('is_active', $object)) {
	328	if ($object->is_active) {
	329	if ($hasDisable) {
	330	$newAction += CRM_Core_Action::DISABLE;
	331	}
	332	}
	333	else {
	334	$newAction += CRM_Core_Action::ENABLE;
	335	}
	336	}
	337	}
	338	}
	339
	340	//CRM-4418, handling edit and delete separately.
	341	$permissions = array($permission);
	342	if ($hasDelete && ($permission == CRM_Core_Permission::EDIT)) {
	343	//previously delete was subset of edit
	344	//so for consistency lets grant delete also.
	345	$permissions[] = CRM_Core_Permission::DELETE;
	346	}
	347
	348	// make sure we only allow those actions that the user is permissioned for
	349	$newAction = $newAction & CRM_Core_Action::mask($permissions);
	350
	351	$values['action'] = CRM_Core_Action::formLink($links, $newAction, array('id' => $object->id));
	352	}
	353
	354	/**
	355	* Edit this entity.
	356	*
	357	* @param int $mode - what mode for the form ?
	358	* @param int $id - id of the entity (for update, view operations)
	359	*
	360	* @return void
	361	*/
	362	function edit($mode, $id = NULL, $imageUpload = FALSE, $pushUserContext = TRUE) {
	363	$controller = new CRM_Core_Controller_Simple($this->editForm(),
	364	$this->editName(),
	365	$mode,
	366	$imageUpload
	367	);
	368
	369	// set the userContext stack
	370	if ($pushUserContext) {
	371	$session = CRM_Core_Session::singleton();
	372	$session->pushUserContext(CRM_Utils_System::url($this->userContext($mode), $this->userContextParams($mode)));
	373	}
	374	if ($id !== NULL) {
	375	$controller->set('id', $id);
	376	}
	377	$controller->set('BAOName', $this->getBAOName());
	378	$this->addValues($controller);
	379	$controller->setEmbedded(TRUE);
	380	$controller->process();
	381	$controller->run();
382	}
383	}
384