-
Notifications
You must be signed in to change notification settings - Fork 902
/
SubscriptionReportPlugin.inc.php
298 lines (268 loc) · 9.45 KB
/
SubscriptionReportPlugin.inc.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<?php
/**
* @file plugins/reports/subscriptions/SubscriptionReportPlugin.inc.php
*
* Copyright (c) 2013-2019 Simon Fraser University
* Copyright (c) 2003-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class SubscriptionReportPlugin
* @ingroup plugins_reports_subscription
*
* @brief Subscription report plugin
*/
import('classes.plugins.ReportPlugin');
class SubscriptionReportPlugin extends ReportPlugin {
/**
* Called as a plugin is registered to the registry
* @param $category String Name of category plugin was registered to
* @return boolean True if plugin initialized successfully; if false,
* the plugin will not be registered.
*/
function register($category, $path) {
$success = parent::register($category, $path);
$this->addLocaleData();
return $success;
}
/**
* Get the name of this plugin. The name must be unique within
* its category.
* @return String name of plugin
*/
function getName() {
return 'SubscriptionReportPlugin';
}
/**
* Get the display name of this plugin.
* @return String display name of plugin
*/
function getDisplayName() {
return __('plugins.reports.subscriptions.displayName');
}
/**
* Get the description text for this plugin.
* @return String description text for this plugin
*/
function getDescription() {
return __('plugins.reports.subscriptions.description');
}
/**
* Generate the subscription report and write CSV contents to file
* @param $args array Request arguments
* @param $request object Request object
*/
function display($args, $request) {
$journal =& Request::getJournal();
$journalId = $journal->getId();
$userDao =& DAORegistry::getDAO('UserDAO');
$countryDao =& DAORegistry::getDAO('CountryDAO');
$subscriptionTypeDao =& DAORegistry::getDAO('SubscriptionTypeDAO');
$individualSubscriptionDao =& DAORegistry::getDAO('IndividualSubscriptionDAO');
$institutionalSubscriptionDao =& DAORegistry::getDAO('InstitutionalSubscriptionDAO');
header('content-type: text/comma-separated-values');
header('content-disposition: attachment; filename=subscriptions-' . date('Ymd') . '.csv');
$fp = fopen('php://output', 'wt');
// Columns for individual subscriptions
$columns = array(__('subscriptionManager.individualSubscriptions'));
PKPString::fputcsv($fp, array_values($columns));
$columnsCommon = array(
'subscription_id' => __('common.id'),
'status' => __('subscriptions.status'),
'type' => __('common.type'),
'format' => __('subscriptionTypes.format'),
'date_start' => __('manager.subscriptions.dateStart'),
'date_end' => __('manager.subscriptions.dateEnd'),
'membership' => __('manager.subscriptions.membership'),
'reference_number' => __('manager.subscriptions.referenceNumber'),
'notes' => __('common.notes')
);
$columnsIndividual = array(
'name' => __('user.name'),
'mailing_address' => __('common.mailingAddress'),
'country' => __('common.country'),
'email' => __('user.email'),
'phone' => __('user.phone'),
'fax' => __('user.fax')
);
$columns = array_merge($columnsCommon, $columnsIndividual);
// Write out individual subscription column headings to file
PKPString::fputcsv($fp, array_values($columns));
// Iterate over individual subscriptions and write out each to file
$individualSubscriptions =& $individualSubscriptionDao->getSubscriptionsByJournalId($journalId);
while ($subscription =& $individualSubscriptions->next()) {
$user =& $userDao->getUser($subscription->getUserId());
$subscriptionType =& $subscriptionTypeDao->getSubscriptionType($subscription->getTypeId());
foreach ($columns as $index => $junk) {
switch ($index) {
case 'subscription_id':
$columns[$index] = $subscription->getId();
break;
case 'status':
$columns[$index] = $subscription->getStatusString();
break;
case 'type':
$columns[$index] = $subscription->getSubscriptionTypeSummaryString();
break;
case 'format':
$columns[$index] = __($subscriptionType->getFormatString());
break;
case 'date_start':
$columns[$index] = $subscription->getDateStart();
break;
case 'date_end':
$columns[$index] = $subscription->getDateEnd();
break;
case 'membership':
$columns[$index] = $subscription->getMembership();
break;
case 'reference_number':
$columns[$index] = $subscription->getReferenceNumber();
break;
case 'notes':
$columns[$index] = $this->_html2text($subscription->getNotes());
break;
case 'name':
$columns[$index] = $user->getFullName();
break;
case 'mailing_address':
$columns[$index] = $this->_html2text($user->getMailingAddress());
break;
case 'country':
$columns[$index] = $countryDao->getCountry($user->getCountry());
break;
case 'email':
$columns[$index] = $user->getEmail();
break;
case 'phone':
$columns[$index] = $user->getPhone();
break;
case 'fax':
$columns[$index] = $user->getFax();
break;
default:
$columns[$index] = '';
}
}
PKPString::fputcsv($fp, $columns);
}
// Columns for institutional subscriptions
$columns = array('');
PKPString::fputcsv($fp, array_values($columns));
$columns = array(__('subscriptionManager.institutionalSubscriptions'));
PKPString::fputcsv($fp, array_values($columns));
$columnsInstitution = array(
'institution_name' => __('manager.subscriptions.institutionName'),
'institution_mailing_address' => __('plugins.reports.subscriptions.institutionMailingAddress'),
'domain' => __('manager.subscriptions.domain'),
'ip_ranges' => __('plugins.reports.subscriptions.ipRanges'),
'contact' => __('manager.subscriptions.contact'),
'mailing_address' => __('common.mailingAddress'),
'country' => __('common.country'),
'email' => __('user.email'),
'phone' => __('user.phone'),
'fax' => __('user.fax')
);
$columns = array_merge($columnsCommon, $columnsInstitution);
// Write out institutional subscription column headings to file
PKPString::fputcsv($fp, array_values($columns));
// Iterate over institutional subscriptions and write out each to file
$institutionalSubscriptions =& $institutionalSubscriptionDao->getSubscriptionsByJournalId($journalId);
while ($subscription =& $institutionalSubscriptions->next()) {
$user =& $userDao->getUser($subscription->getUserId());
$subscriptionType =& $subscriptionTypeDao->getSubscriptionType($subscription->getTypeId());
foreach ($columns as $index => $junk) {
switch ($index) {
case 'subscription_id':
$columns[$index] = $subscription->getId();
break;
case 'status':
$columns[$index] = $subscription->getStatusString();
break;
case 'type':
$columns[$index] = $subscription->getSubscriptionTypeSummaryString();
break;
case 'format':
$columns[$index] = __($subscriptionType->getFormatString());
break;
case 'date_start':
$columns[$index] = $subscription->getDateStart();
break;
case 'date_end':
$columns[$index] = $subscription->getDateEnd();
break;
case 'membership':
$columns[$index] = $subscription->getMembership();
break;
case 'reference_number':
$columns[$index] = $subscription->getReferenceNumber();
break;
case 'notes':
$columns[$index] = $this->_html2text($subscription->getNotes());
break;
case 'institution_name':
$columns[$index] = $subscription->getInstitutionName();
break;
case 'institution_mailing_address':
$columns[$index] = $this->_html2text($subscription->getInstitutionMailingAddress());
break;
case 'domain':
$columns[$index] = $subscription->getDomain();
break;
case 'ip_ranges':
$columns[$index] = $this->_formatIPRanges($subscription->getIPRanges());
break;
case 'contact':
$columns[$index] = $user->getFullName();
break;
case 'mailing_address':
$columns[$index] = $this->_html2text($user->getMailingAddress());
break;
case 'country':
$columns[$index] = $countryDao->getCountry($user->getCountry());
break;
case 'email':
$columns[$index] = $user->getEmail();
break;
case 'phone':
$columns[$index] = $user->getPhone();
break;
case 'fax':
$columns[$index] = $user->getFax();
break;
default:
$columns[$index] = '';
}
}
PKPString::fputcsv($fp, $columns);
}
fclose($fp);
}
/**
* Replace HTML "newline" tags (p, li, br) with line feeds. Strip all other tags.
* @param $html String Input HTML string
* @return String Text with replaced and stripped HTML tags
*/
function _html2text($html) {
$html = PKPString::regexp_replace('/<[\/]?p>/', chr(13) . chr(10), $html);
$html = PKPString::regexp_replace('/<li>/', '• ', $html);
$html = PKPString::regexp_replace('/<\/li>/', chr(13) . chr(10), $html);
$html = PKPString::regexp_replace('/<br[ ]?[\/]?>/', chr(13) . chr(10), $html);
$html = PKPString::html2utf(strip_tags($html));
return $html;
}
/**
* Pretty format IP ranges, one per line via line feeds.
* @param $ipRanges array IP ranges
* @return String Text of IP ranges formatted with newlines
*/
function _formatIPRanges($ipRanges) {
$numRanges = count($ipRanges);
$ipRangesString = '';
for($i=0; $i<$numRanges; $i++) {
$ipRangesString .= $ipRanges[$i];
if ( $i+1 < $numRanges) $ipRangesString .= chr(13) . chr(10);
}
return $ipRangesString;
}
}
?>