3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
36 * This class generates form components for custom data
38 * It delegates the work to lower level subclasses and integrates the changes
39 * back in. It also uses a lot of functionality with the CRM API's, so any change
40 * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
43 class CRM_Profile_Form_Edit
extends CRM_Profile_Form
{
44 protected $_postURL = NULL;
45 protected $_cancelURL = NULL;
46 protected $_errorURL = NULL;
50 protected $returnExtra;
53 * Pre processing work done here.
58 public function preProcess() {
59 $this->_mode
= CRM_Profile_Form
::MODE_CREATE
;
61 $this->_onPopupClose
= CRM_Utils_Request
::retrieve('onPopupClose', 'String', $this);
62 $this->assign('onPopupClose', $this->_onPopupClose
);
64 //set the context for the profile
65 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
68 $this->_blockNo
= CRM_Utils_Request
::retrieve('blockNo', 'String', $this);
71 $this->_prefix
= CRM_Utils_Request
::retrieve('prefix', 'String', $this);
73 // Fields for the EntityRef widget
74 $this->returnExtra
= CRM_Utils_Request
::retrieve('returnExtra', 'String', $this);
76 $this->assign('context', $this->_context
);
78 if ($this->_blockNo
) {
79 $this->assign('blockNo', $this->_blockNo
);
80 $this->assign('prefix', $this->_prefix
);
83 $this->assign('createCallback', CRM_Utils_Request
::retrieve('createCallback', 'String', $this));
85 if ($this->get('skipPermission')) {
86 $this->_skipPermission
= TRUE;
89 if ($this->get('edit')) {
90 // make sure we have right permission to edit this user
91 $session = CRM_Core_Session
::singleton();
92 $userID = $session->get('userID');
94 // Set the ID from the query string, otherwise default to the current user
95 $id = CRM_Utils_Request
::retrieve('id', 'Positive', $this, FALSE, $userID);
99 $this->_mode
= CRM_Profile_Form
::MODE_EDIT
;
101 if ($id != $userID) {
102 // do not allow edit for anon users in joomla frontend, CRM-4668, unless u have checksum CRM-5228
103 // see also CRM-19079 for modifications to the condition
104 $config = CRM_Core_Config
::singleton();
105 if ($config->userFrameworkFrontend
&& $config->userSystem
->is_joomla
) {
106 CRM_Contact_BAO_Contact_Permission
::validateOnlyChecksum($id, $this);
109 CRM_Contact_BAO_Contact_Permission
::validateChecksumContact($id, $this);
111 $this->_isPermissionedChecksum
= TRUE;
115 // CRM-16784: If there is no ID then this can't be an 'edit'
117 CRM_Core_Error
::fatal(ts('No user/contact ID was specified, so the Profile cannot be used in edit mode.'));
122 parent
::preProcess();
124 // and also the profile is of type 'Profile'
126 SELECT module,is_reserved
127 FROM civicrm_uf_group
128 LEFT JOIN civicrm_uf_join ON uf_group_id = civicrm_uf_group.id
129 WHERE civicrm_uf_group.id = %1
132 $params = array(1 => array($this->_gid
, 'Integer'));
133 $dao = CRM_Core_DAO
::executeQuery($query, $params);
136 while ($dao->fetch()) {
137 $isProfile = ($isProfile ||
($dao->module
== "Profile"));
140 //Check that the user has the "add contacts" Permission
141 $canAdd = CRM_Core_Permission
::check("add contacts");
143 //Remove need for Profile module type when using reserved profiles [CRM-14488]
144 if (!$dao->N ||
(!$isProfile && !($dao->is_reserved
&& $canAdd))) {
145 CRM_Core_Error
::fatal(ts('The requested Profile (gid=%1) is not configured to be used for \'Profile\' edit and view forms in its Settings. Contact the site administrator if you need assistance.',
146 array(1 => $this->_gid
)
152 * Build the form object.
155 public function buildQuickForm() {
156 if (empty($this->_ufGroup
['id'])) {
157 CRM_Core_Error
::fatal();
161 if ($this->_multiRecord
&& $this->_customGroupTitle
) {
162 $groupTitle = ($this->_multiRecord
& CRM_Core_Action
::UPDATE
) ?
'Edit ' . $this->_customGroupTitle
. ' Record' : $this->_customGroupTitle
;
166 $groupTitle = $this->_ufGroup
['title'];
168 CRM_Utils_System
::setTitle($groupTitle);
169 $this->assign('recentlyViewed', FALSE);
171 if ($this->_context
!= 'dialog') {
172 $this->_postURL
= $this->_ufGroup
['post_URL'];
173 $this->_cancelURL
= $this->_ufGroup
['cancel_URL'];
175 $gidString = $this->_gid
;
176 if (!empty($this->_profileIds
)) {
177 $gidString = implode(',', $this->_profileIds
);
180 if (!$this->_postURL
) {
181 if ($this->_context
== 'Search') {
182 $this->_postURL
= CRM_Utils_System
::url('civicrm/contact/search');
184 elseif ($this->_id
&& $this->_gid
) {
185 $urlParams = "reset=1&id={$this->_id}&gid={$gidString}";
186 if ($this->_isContactActivityProfile
&& $this->_activityId
) {
187 $urlParams .= "&aid={$this->_activityId}";
189 // get checksum if present
190 if ($this->get('cs')) {
191 $urlParams .= "&cs=" . $this->get('cs');
193 $this->_postURL
= CRM_Utils_System
::url('civicrm/profile/view', $urlParams);
197 if (!$this->_cancelURL
) {
198 $this->_cancelURL
= CRM_Utils_System
::url('civicrm/profile',
199 "reset=1&gid={$gidString}"
203 // we do this gross hack since qf also does entity replacement
204 $this->_postURL
= str_replace('&', '&', $this->_postURL
);
205 $this->_cancelURL
= str_replace('&', '&', $this->_cancelURL
);
207 // also retain error URL if set
208 $this->_errorURL
= CRM_Utils_Array
::value('errorURL', $_POST);
209 if ($this->_errorURL
) {
210 // we do this gross hack since qf also does entity replacement
211 $this->_errorURL
= str_replace('&', '&', $this->_errorURL
);
212 $this->addElement('hidden', 'errorURL', $this->_errorURL
);
215 // replace the session stack in case user cancels (and we dont go into postProcess)
216 $session = CRM_Core_Session
::singleton();
217 $session->replaceUserContext($this->_postURL
);
220 parent
::buildQuickForm();
222 $this->assign('cancelURL', $this->_cancelURL
);
224 if (($this->_multiRecord
& CRM_Core_Action
::DELETE
) && $this->_recordExists
) {
225 $this->_deleteButtonName
= $this->getButtonName('upload', 'delete');
227 $this->addElement('submit', $this->_deleteButtonName
, ts('Delete'));
232 //get the value from session, this is set if there is any file
234 $uploadNames = $this->get('uploadNames');
236 if (!empty($uploadNames)) {
237 $buttonName = 'upload';
240 $buttonName = 'next';
244 'type' => $buttonName,
245 'name' => ts('Save'),
249 $this->addButtons($buttons);
251 $this->addFormRule(array('CRM_Profile_Form', 'formRule'), $this);
255 * Process the user submitted custom data values.
258 public function postProcess() {
259 parent
::postProcess();
261 // Send back data for the EntityRef widget
262 if ($this->returnExtra
) {
263 $contact = civicrm_api3('Contact', 'getsingle', array(
265 'return' => $this->returnExtra
,
267 foreach (explode(',', $this->returnExtra
) as $field) {
268 $field = trim($field);
269 $this->ajaxResponse
['extra'][$field] = CRM_Utils_Array
::value($field, $contact);
273 // When saving (not deleting) and not in an ajax popup
274 if (empty($_POST[$this->_deleteButtonName
]) && $this->_context
!= 'dialog') {
275 CRM_Core_Session
::setStatus(ts('Your information has been saved.'), ts('Thank you.'), 'success');
278 $session = CRM_Core_Session
::singleton();
279 // only replace user context if we do not have a postURL
280 if (!$this->_postURL
) {
281 $gidString = $this->_gid
;
282 if (!empty($this->_profileIds
)) {
283 $gidString = implode(',', $this->_profileIds
);
286 $urlParams = "reset=1&id={$this->_id}&gid={$gidString}";
287 if ($this->_isContactActivityProfile
&& $this->_activityId
) {
288 $urlParams .= "&aid={$this->_activityId}";
290 // Get checksum if present
291 if ($this->get('cs')) {
292 $urlParams .= "&cs=" . $this->get('cs');
294 // Generate one if needed
295 elseif (!CRM_Contact_BAO_Contact_Permission
::allow($this->_id
)) {
296 $urlParams .= "&cs=" . CRM_Contact_BAO_Contact_Utils
::generateChecksum($this->_id
);
298 $url = CRM_Utils_System
::url('civicrm/profile/view', $urlParams);
301 // Replace tokens from post URL
302 $contactParams = array(
303 'contact_id' => $this->_id
,
307 $contact = civicrm_api('contact', 'get', $contactParams);
308 $contact = reset($contact['values']);
310 $dummyMail = new CRM_Mailing_BAO_Mailing();
311 $dummyMail->body_text
= $this->_postURL
;
312 $tokens = $dummyMail->getTokens();
314 $url = CRM_Utils_Token
::replaceContactTokens($this->_postURL
, $contact, FALSE, CRM_Utils_Array
::value('text', $tokens));
317 $session->replaceUserContext($url);
321 * Intercept QF validation and do our own redirection.
323 * We use this to send control back to the user for a user formatted page
324 * This allows the user to maintain the same state and display the error messages
325 * in their own theme along with any modifications
327 * This is a first version and will be tweaked over a period of time
331 * true if no error found
333 public function validate() {
334 $errors = parent
::validate();
336 if (!$errors && !empty($_POST['errorURL'])) {
338 foreach ($this->_errors
as $name => $mess) {
343 CRM_Utils_System
::setUFMessage($message);
345 $message = urlencode($message);
347 $errorURL = $_POST['errorURL'];
348 if (strpos($errorURL, '?') !== FALSE) {
354 $errorURL .= "gid={$this->_gid}&msg=$message";
355 CRM_Utils_System
::redirect($errorURL);