Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * This class introduces component to the system and provides all the | |
30 | * information about it. It needs to extend CRM_Core_Component_Info | |
31 | * abstract class. | |
32 | * | |
33 | * @package CRM | |
e7112fa7 | 34 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
35 | * $Id$ |
36 | * | |
37 | */ | |
38 | class CRM_Mailing_Info extends CRM_Core_Component_Info { | |
39 | ||
e7c15cb6 CW |
40 | /** |
41 | * @inheritDoc | |
42 | */ | |
6a488035 TO |
43 | protected $keyword = 'mailing'; |
44 | ||
45 | ||
e0ef6999 | 46 | /** |
e7c15cb6 | 47 | * @inheritDoc |
e0ef6999 EM |
48 | * @return array |
49 | */ | |
6a488035 TO |
50 | public function getInfo() { |
51 | return array( | |
52 | 'name' => 'CiviMail', | |
53 | 'translatedName' => ts('CiviMail'), | |
54 | 'title' => 'CiviCRM Mailing Engine', | |
55 | 'search' => 1, | |
56 | 'showActivitiesInCore' => 1, | |
57 | ); | |
58 | } | |
59 | ||
ced9bfed | 60 | /** |
a0f40af4 | 61 | * Get AngularJS modules and their dependencies |
ced9bfed EM |
62 | * |
63 | * @return array | |
64 | * list of modules; same format as CRM_Utils_Hook::angularModules(&$angularModules) | |
65 | * @see CRM_Utils_Hook::angularModules | |
66 | */ | |
4aef704e | 67 | public function getAngularModules() { |
68 | $result = array(); | |
88e9e883 | 69 | $result['crmMailing'] = array( |
030dce01 | 70 | 'ext' => 'civicrm', |
353ffa53 | 71 | 'js' => array( |
81bb7011 TO |
72 | 'ang/crmMailing.js', |
73 | 'ang/crmMailing/*.js', | |
353ffa53 | 74 | ), |
81bb7011 TO |
75 | 'css' => array('ang/crmMailing.css'), |
76 | 'partials' => array('ang/crmMailing'), | |
6bea4a47 | 77 | ); |
4aef704e | 78 | $result['crmMailingAB'] = array( |
79 | 'ext' => 'civicrm', | |
353ffa53 | 80 | 'js' => array( |
679996bb TO |
81 | 'ang/crmMailingAB.js', |
82 | 'ang/crmMailingAB/*.js', | |
83 | 'ang/crmMailingAB/*/*.js', | |
353ffa53 | 84 | ), |
e9f5761a | 85 | 'css' => array('ang/crmMailingAB.css'), |
6f54251a | 86 | 'partials' => array('ang/crmMailingAB'), |
4aef704e | 87 | ); |
d74bca86 TO |
88 | $result['crmD3'] = array( |
89 | 'ext' => 'civicrm', | |
edb34488 | 90 | 'js' => array( |
6f54251a | 91 | 'ang/crmD3.js', |
edb34488 TO |
92 | 'bower_components/d3/d3.min.js', |
93 | ), | |
d74bca86 | 94 | ); |
983052fe | 95 | |
8099bfee | 96 | $config = CRM_Core_Config::singleton(); |
6bea4a47 TO |
97 | $session = CRM_Core_Session::singleton(); |
98 | $contactID = $session->get('userID'); | |
d979898e | 99 | |
51527a6e CW |
100 | // Get past mailings |
101 | // CRM-16155 - Limit to a reasonable number | |
102 | $civiMails = civicrm_api3('Mailing', 'get', array( | |
72dd949e | 103 | 'is_completed' => 1, |
51527a6e | 104 | 'mailing_type' => array('IN' => array('standalone', 'winner')), |
72dd949e | 105 | 'return' => array('id', 'name', 'scheduled_date'), |
51527a6e CW |
106 | 'sequential' => 1, |
107 | 'options' => array( | |
108 | 'limit' => 500, | |
109 | 'sort' => 'is_archived asc, scheduled_date desc', | |
8099bfee | 110 | ), |
51527a6e CW |
111 | )); |
112 | // Generic params | |
a0f40af4 CW |
113 | $params = array( |
114 | 'options' => array('limit' => 0), | |
115 | 'sequential' => 1, | |
116 | ); | |
8099bfee | 117 | |
a0f40af4 CW |
118 | $groupNames = civicrm_api3('Group', 'get', $params + array( |
119 | 'is_active' => 1, | |
120 | 'return' => array('title', 'visibility', 'group_type', 'is_hidden'), | |
121 | )); | |
122 | $headerfooterList = civicrm_api3('MailingComponent', 'get', $params + array( | |
123 | 'is_active' => 1, | |
0499685e | 124 | 'return' => array('name', 'component_type', 'is_default', 'body_html', 'body_text'), |
72dd949e | 125 | )); |
6bea4a47 | 126 | |
44a7c67d TO |
127 | $emailAdd = civicrm_api3('Email', 'get', array( |
128 | 'sequential' => 1, | |
129 | 'return' => "email", | |
130 | 'contact_id' => $contactID, | |
131 | )); | |
a0f40af4 CW |
132 | |
133 | // FIXME: Loading the contents of every template into the dom does not scale well | |
d979898e | 134 | $mesTemplate = civicrm_api3('MessageTemplate', 'get', $params + array( |
44a7c67d | 135 | 'sequential' => 1, |
a0f40af4 | 136 | 'is_active' => 1, |
44a7c67d | 137 | 'return' => array("msg_html", "id", "msg_title", "msg_subject", "msg_text"), |
44a7c67d TO |
138 | 'workflow_id' => array('IS NULL' => ""), |
139 | )); | |
a0f40af4 CW |
140 | $mailTokens = civicrm_api3('Mailing', 'gettokens', array( |
141 | 'entity' => array('contact', 'mailing'), | |
8099bfee | 142 | 'sequential' => 1, |
a0f40af4 | 143 | )); |
d979898e CW |
144 | $fromAddress = civicrm_api3('OptionValue', 'get', $params + array( |
145 | 'option_group_id' => "from_email_address", | |
4aef704e | 146 | )); |
a0f40af4 CW |
147 | CRM_Core_Resources::singleton() |
148 | ->addSetting(array( | |
149 | 'crmMailing' => array( | |
150 | 'civiMails' => $civiMails['values'], | |
8099bfee | 151 | 'campaignEnabled' => in_array('CiviCampaign', $config->enableComponents), |
a0f40af4 CW |
152 | 'groupNames' => $groupNames['values'], |
153 | 'headerfooterList' => $headerfooterList['values'], | |
154 | 'mesTemplate' => $mesTemplate['values'], | |
155 | 'emailAdd' => $emailAdd['values'], | |
a0f40af4 CW |
156 | 'mailTokens' => $mailTokens['values'], |
157 | 'contactid' => $contactID, | |
158 | 'requiredTokens' => CRM_Utils_Token::getRequiredTokens(), | |
159 | 'enableReplyTo' => (int) CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'replyTo'), | |
d124a91f | 160 | 'disableMandatoryTokensCheck' => (int) CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'disable_mandatory_tokens_check'), |
a0f40af4 CW |
161 | 'fromAddress' => $fromAddress['values'], |
162 | 'defaultTestEmail' => civicrm_api3('Contact', 'getvalue', array( | |
163 | 'id' => 'user_contact_id', | |
164 | 'return' => 'email', | |
165 | )), | |
166 | 'visibility' => CRM_Utils_Array::makeNonAssociative(CRM_Core_SelectValues::groupVisibility()), | |
167 | 'workflowEnabled' => CRM_Mailing_Info::workflowEnabled(), | |
168 | ), | |
169 | )) | |
170 | ->addPermissions(array( | |
171 | 'view all contacts', | |
172 | 'access CiviMail', | |
173 | 'create mailings', | |
174 | 'schedule mailings', | |
175 | 'approve mailings', | |
176 | 'delete in CiviMail', | |
177 | )); | |
983052fe | 178 | |
4aef704e | 179 | return $result; |
180 | } | |
983052fe | 181 | |
4aef704e | 182 | /** |
e0ef6999 EM |
183 | * @return bool |
184 | */ | |
00be9182 | 185 | public static function workflowEnabled() { |
6a488035 TO |
186 | $config = CRM_Core_Config::singleton(); |
187 | ||
188 | // early exit, since not true for most | |
189 | if (!$config->userSystem->is_drupal || | |
190 | !function_exists('module_exists') | |
191 | ) { | |
192 | return FALSE; | |
193 | } | |
194 | ||
195 | if (!module_exists('rules')) { | |
196 | return FALSE; | |
197 | } | |
198 | ||
199 | $enableWorkflow = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, | |
200 | 'civimail_workflow', | |
201 | NULL, | |
202 | FALSE | |
203 | ); | |
204 | ||
205 | return ($enableWorkflow && | |
206 | $config->userSystem->is_drupal | |
207 | ) ? TRUE : FALSE; | |
208 | } | |
209 | ||
e0ef6999 | 210 | /** |
e7c15cb6 | 211 | * @inheritDoc |
e0ef6999 | 212 | * @param bool $getAllUnconditionally |
221b21b4 AH |
213 | * @param bool $descriptions |
214 | * Whether to return permission descriptions | |
e0ef6999 EM |
215 | * |
216 | * @return array | |
217 | */ | |
221b21b4 | 218 | public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) { |
6a488035 | 219 | $permissions = array( |
221b21b4 AH |
220 | 'access CiviMail' => array( |
221 | ts('access CiviMail'), | |
222 | ), | |
223 | 'access CiviMail subscribe/unsubscribe pages' => array( | |
224 | ts('access CiviMail subscribe/unsubscribe pages'), | |
225 | ts('Subscribe/unsubscribe from mailing list group'), | |
226 | ), | |
227 | 'delete in CiviMail' => array( | |
228 | ts('delete in CiviMail'), | |
229 | ts('Delete Mailing'), | |
230 | ), | |
231 | 'view public CiviMail content' => array( | |
232 | ts('view public CiviMail content'), | |
233 | ), | |
6a488035 TO |
234 | ); |
235 | ||
33777e4a | 236 | if (self::workflowEnabled() || $getAllUnconditionally) { |
221b21b4 AH |
237 | $permissions[] = array( |
238 | 'create mailings' => array( | |
239 | ts('create mailings'), | |
240 | ), | |
241 | ); | |
242 | $permissions[] = array( | |
243 | 'schedule mailings' => array( | |
244 | ts('schedule mailings'), | |
245 | ), | |
246 | ); | |
247 | $permissions[] = array( | |
248 | 'approve mailings' => array( | |
249 | ts('approve mailings'), | |
250 | ), | |
251 | ); | |
252 | } | |
253 | ||
254 | if (!$descriptions) { | |
255 | foreach ($permissions as $name => $attr) { | |
256 | $permissions[$name] = array_shift($attr); | |
257 | } | |
6a488035 TO |
258 | } |
259 | ||
260 | return $permissions; | |
261 | } | |
262 | ||
263 | ||
e0ef6999 | 264 | /** |
e7c15cb6 | 265 | * @inheritDoc |
e0ef6999 EM |
266 | * @return null |
267 | */ | |
6a488035 TO |
268 | public function getUserDashboardElement() { |
269 | // no dashboard element for this component | |
270 | return NULL; | |
271 | } | |
272 | ||
e0ef6999 EM |
273 | /** |
274 | * @return null | |
275 | */ | |
6a488035 TO |
276 | public function getUserDashboardObject() { |
277 | // no dashboard element for this component | |
278 | return NULL; | |
279 | } | |
280 | ||
e0ef6999 | 281 | /** |
e7c15cb6 | 282 | * @inheritDoc |
e0ef6999 EM |
283 | * @return array |
284 | */ | |
6a488035 | 285 | public function registerTab() { |
2ede60ec DL |
286 | return array( |
287 | 'title' => ts('Mailings'), | |
288 | 'id' => 'mailing', | |
289 | 'url' => 'mailing', | |
290 | 'weight' => 45, | |
291 | ); | |
6a488035 TO |
292 | } |
293 | ||
e0ef6999 | 294 | /** |
e7c15cb6 | 295 | * @inheritDoc |
e0ef6999 EM |
296 | * @return array |
297 | */ | |
6a488035 | 298 | public function registerAdvancedSearchPane() { |
35f7561f | 299 | return array( |
353ffa53 | 300 | 'title' => ts('Mailings'), |
6a488035 TO |
301 | 'weight' => 20, |
302 | ); | |
303 | } | |
304 | ||
e0ef6999 | 305 | /** |
e7c15cb6 | 306 | * @inheritDoc |
e0ef6999 EM |
307 | * @return null |
308 | */ | |
6a488035 TO |
309 | public function getActivityTypes() { |
310 | return NULL; | |
311 | } | |
312 | ||
e0ef6999 | 313 | /** |
fe482240 | 314 | * add shortcut to Create New. |
e0ef6999 EM |
315 | * @param $shortCuts |
316 | */ | |
35f7561f TO |
317 | public function creatNewShortcut(&$shortCuts) { |
318 | } | |
96025800 | 319 | |
6a488035 | 320 | } |