forked from defstat/pln
-
Notifications
You must be signed in to change notification settings - Fork 2
/
PLNPlugin.inc.php
776 lines (675 loc) · 24.2 KB
/
PLNPlugin.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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
<?php
/**
* @file plugins/generic/pln/PLNPlugin.inc.php
*
* Copyright (c) 2013-2017 Simon Fraser University Library
* Copyright (c) 2003-2017 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class PLNPlugin
* @ingroup plugins_generic_pln
*
* @brief PLN plugin class
*/
import('lib.pkp.classes.plugins.GenericPlugin');
import('lib.pkp.classes.config.Config');
import('classes.article.PublishedArticle');
import('classes.issue.Issue');
define('PLN_PLUGIN_NAME', 'plnplugin');
// defined here in case an upgrade doesn't pick up the default value.
define('PLN_DEFAULT_NETWORK', 'http://pkp-pln.lib.sfu.ca');
define('PLN_DEFAULT_STATUS_SUFFIX', '/docs/status');
define('PLN_PLUGIN_HTTP_STATUS_OK', 200);
define('PLN_PLUGIN_HTTP_STATUS_CREATED', 201);
define('PLN_PLUGIN_XML_NAMESPACE', 'http://pkp.sfu.ca/SWORD');
// base IRI for the SWORD server. IRIs are constructed by appending to
// this constant.
define('PLN_PLUGIN_BASE_IRI', '/api/sword/2.0');
// used to retrieve the service document
define('PLN_PLUGIN_SD_IRI', PLN_PLUGIN_BASE_IRI . '/sd-iri');
// used to submit a deposit
define('PLN_PLUGIN_COL_IRI', PLN_PLUGIN_BASE_IRI . '/col-iri');
// used to edit and query the state of a deposit
define('PLN_PLUGIN_CONT_IRI', PLN_PLUGIN_BASE_IRI . '/cont-iri');
define('PLN_PLUGIN_ARCHIVE_FOLDER', 'pln');
// local statuses
define('PLN_PLUGIN_DEPOSIT_STATUS_NEW', 0x00);
define('PLN_PLUGIN_DEPOSIT_STATUS_PACKAGED', 0x01);
define('PLN_PLUGIN_DEPOSIT_STATUS_TRANSFERRED', 0x02);
define('PLN_PLUGIN_DEPOSIT_STATUS_PACKAGING_FAILED', 0x200);
// status on the processing server
define('PLN_PLUGIN_DEPOSIT_STATUS_RECEIVED', 0x04);
define('PLN_PLUGIN_DEPOSIT_STATUS_VALIDATED', 0x08); // was SYNCING
define('PLN_PLUGIN_DEPOSIT_STATUS_SENT', 0x10); // was SYNCED
// status in the LOCKSS PLN
define('PLN_PLUGIN_DEPOSIT_STATUS_LOCKSS_RECEIVED', 0x20); // was REMOTE_FAILURE
define('PLN_PLUGIN_DEPOSIT_STATUS_LOCKSS_SYNCING', 0x40); // was LOCAL_FAILURE
define('PLN_PLUGIN_DEPOSIT_STATUS_LOCKSS_AGREEMENT', 0x80); // was UPDATE
define('PLN_PLUGIN_DEPOSIT_STATUS_UPDATE', 0x100);
define('PLN_PLUGIN_DEPOSIT_OBJECT_ARTICLE', 'PublishedArticle');
define('PLN_PLUGIN_DEPOSIT_OBJECT_ISSUE', 'Issue');
define('PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE', NOTIFICATION_TYPE_PLUGIN_BASE + 0x10000000);
define('PLN_PLUGIN_NOTIFICATION_TYPE_TERMS_UPDATED', PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE + 0x0000001);
define('PLN_PLUGIN_NOTIFICATION_TYPE_ISSN_MISSING', PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE + 0x0000002);
define('PLN_PLUGIN_NOTIFICATION_TYPE_HTTP_ERROR', PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE + 0x0000003);
define('PLN_PLUGIN_NOTIFICATION_TYPE_CURL_MISSING', PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE + 0x0000004);
define('PLN_PLUGIN_NOTIFICATION_TYPE_ZIP_MISSING', PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE + 0x0000005);
define('PLN_PLUGIN_NOTIFICATION_TYPE_TAR_MISSING', PLN_PLUGIN_NOTIFICATION_TYPE_PLUGIN_BASE + 0x0000006);
class PLNPlugin extends GenericPlugin {
/**
* @copydoc LazyLoadPlugin::register()
*/
function register($category, $path, $mainContextId = null) {
$success = parent::register($category, $path, $mainContextId);
if ($success) {
HookRegistry::register('Templates::Manager::Setup::JournalArchiving', array($this, 'callbackJournalArchivingSetup'));
if ($this->getEnabled()) {
$this->registerDAOs();
$this->import('classes.Deposit');
$this->import('classes.DepositObject');
$this->import('classes.DepositPackage');
HookRegistry::register('PluginRegistry::loadCategory', array($this, 'callbackLoadCategory'));
HookRegistry::register('JournalDAO::deleteJournalById', array($this, 'callbackDeleteJournalById'));
HookRegistry::register('LoadHandler', array($this, 'callbackLoadHandler'));
HookRegistry::register('NotificationManager::getNotificationContents', array($this, 'callbackNotificationContents'));
HookRegistry::register('LoadComponentHandler', array($this, 'setupComponentHandlers'));
HookRegistry::register('AcronPlugin::parseCronTab', array($this, 'callbackParseCronTab'));
}
}
return $success;
}
/**
* Permit requests to the static pages grid handler
* @param $hookName string The name of the hook being invoked
* @param $args array The parameters to the invoked hook
*/
function setupComponentHandlers($hookName, $params) {
$component = $params[0];
switch ($component) {
case 'plugins.generic.pln.controllers.grid.PLNStatusGridHandler':
// Allow the PLN status grid handler to get the plugin object
import($component);
$componentPieces = explode('.', $component);
$className = array_pop($componentPieces);
$className::setPlugin($this);
return true;
}
return false;
}
/**
* @see Plugin::getActions()
*/
function getActions($request, $verb) {
$router = $request->getRouter();
import('lib.pkp.classes.linkAction.request.AjaxModal');
return array_merge(
$this->getEnabled()?array(
new LinkAction(
'settings',
new AjaxModal(
$router->url($request, null, null, 'manage', null, array('verb' => 'settings', 'plugin' => $this->getName(), 'category' => 'generic')),
$this->getDisplayName()
),
__('manager.plugins.settings'),
null
),
new LinkAction(
'status',
new AjaxModal(
$router->url($request, null, null, 'manage', null, array('verb' => 'status', 'plugin' => $this->getName(), 'category' => 'generic')),
$this->getDisplayName()
),
__('common.status'),
null
)
):array(),
parent::getActions($request, $verb)
);
}
/**
* Register this plugin's DAOs with the application
*/
function registerDAOs() {
$this->import('classes.DepositDAO');
$this->import('classes.DepositObjectDAO');
$depositDao = new DepositDAO($this->getName());
DAORegistry::registerDAO('DepositDAO', $depositDao);
$depositObjectDao = new DepositObjectDAO($this->getName());
DAORegistry::registerDAO('DepositObjectDAO', $depositObjectDao);
}
/**
* @see PKPPlugin::getDisplayName()
* @return string
*/
function getDisplayName() {
return __('plugins.generic.pln');
}
/**
* @see PKPPlugin::getDescription()
* @return string
*/
function getDescription() {
return __('plugins.generic.pln.description');
}
/**
* @see PKPPlugin::getInstallSchemaFile()
* @return string
*/
function getInstallSchemaFile() {
return $this->getPluginPath() . DIRECTORY_SEPARATOR . 'xml' . DIRECTORY_SEPARATOR . 'schema.xml';
}
/**
* @see PKPPlugin::getHandlerPath()
* @return string
*/
function getHandlerPath() {
return $this->getPluginPath() . DIRECTORY_SEPARATOR . 'pages';
}
///**
// * @copydoc Plugin::getTemplatePath()
// */
//function getTemplatePath($inCore = false) {
// return parent::getTemplatePath($inCore) . 'templates/';
//}
/**
* @see PKPPlugin::getContextSpecificPluginSettingsFile()
* @return string
*/
function getContextSpecificPluginSettingsFile() {
return $this->getPluginPath() . DIRECTORY_SEPARATOR . 'xml' . DIRECTORY_SEPARATOR . 'settings.xml';
}
/**
* @see PKPPlugin::getSetting()
* @param $journalId int
* @param $settingName string
*/
function getSetting($journalId, $settingName) {
// if there isn't a journal_uuid, make one
switch ($settingName) {
case 'journal_uuid':
$uuid = parent::getSetting($journalId, $settingName);
if (!is_null($uuid) && $uuid != '')
return $uuid;
$this->updateSetting($journalId, $settingName, $this->newUUID());
break;
case 'object_type':
$type = parent::getSetting($journalId, $settingName);
if( ! is_null($type))
return $type;
$this->updateSetting($journalId, $settingName, PLN_PLUGIN_DEPOSIT_OBJECT_ISSUE);
break;
case 'pln_network':
return Config::getVar('lockss', 'pln_url', PLN_DEFAULT_NETWORK);
case 'pln_status_docs':
return Config::getVar('lockss', 'pln_status_docs', Config::getVar('lockss', 'pln_url', PLN_DEFAULT_NETWORK) . PLN_DEFAULT_STATUS_SUFFIX);
default:
break;
}
return parent::getSetting($journalId, $settingName);
}
/**
* Register as a gateway plugin.
* @param $hookName string
* @param $args array
*/
function callbackLoadCategory($hookName, $args) {
$category =& $args[0];
$plugins =& $args[1];
switch ($category) {
case 'gateways':
$this->import('PLNGatewayPlugin');
$gatewayPlugin = new PLNGatewayPlugin($this->getName());
$plugins[$gatewayPlugin->getSeq()][$gatewayPlugin->getPluginPath()] =& $gatewayPlugin;
break;
}
return false;
}
/**
* Delete all plug-in data for a journal when the journal is deleted
* @param $hookName string (JournalDAO::deleteJournalById)
* @param $args array (JournalDAO, journalId)
* @return boolean false to continue processing subsequent hooks
*/
function callbackDeleteJournalById($hookName, $params) {
$journalId = $params[1];
$depositDao = DAORegistry::getDAO('DepositDAO');
$depositDao->deleteByJournalId($journalId);
$depositObjectDao = DAORegistry::getDAO('DepositObjectDAO');
$depositObjectDao->deleteByJournalId($journalId);
return false;
}
/**
* @copydoc AcronPlugin::parseCronTab()
*/
function callbackParseCronTab($hookName, $args) {
$taskFilesPath =& $args[0];
$taskFilesPath[] = $this->getPluginPath() . '/xml/scheduledTasks.xml';
return false;
}
/**
* A callback used to populate journal setup step 2.6 with PLN preservation info
* @param $hookName string (Templates::Manager::Setup::JournalArchiving)
* @param $args array
* @return boolean false to continue processing subsequent hooks
*/
function callbackJournalArchivingSetup($hookName, $args) {
$smarty = $args[1];
$output = $args[2];
$templateMgr = TemplateManager::getManager();
$templateMgr->register_function('plugin_url', array(&$this, 'smartyPluginUrl'));
$output .= $templateMgr->fetch($this->getTemplateResource('setup.tpl'));
return false;
}
/**
* Hook registry function to provide notification messages
* @param $hookName string (NotificationManager::getNotificationContents)
* @param $args array ($notification, $message)
* @return boolean false to continue processing subsequent hooks
*/
function callbackNotificationContents($hookName, $args) {
$notification = $args[0];
$message = $args[1];
$type = $notification->getType();
assert(isset($type));
switch ($type) {
case PLN_PLUGIN_NOTIFICATION_TYPE_TERMS_UPDATED:
$message = __('plugins.generic.pln.notifications.terms_updated');
break;
case PLN_PLUGIN_NOTIFICATION_TYPE_ISSN_MISSING:
$message = __('plugins.generic.pln.notifications.issn_missing');
break;
case PLN_PLUGIN_NOTIFICATION_TYPE_HTTP_ERROR:
$message = __('plugins.generic.pln.notifications.http_error');
break;
}
}
/**
* @copydoc PKPPageRouter::route()
*/
function callbackLoadHandler($hookName, $args) {
$page =& $args[0];
if ($page == 'pln') {
$op = $args[1];
if ($op) {
if (in_array($op, array('deposits'))) {
define('HANDLER_CLASS', 'PLNHandler');
define('PLN_PLUGIN_NAME', $this->getName());
AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON);
$handlerFile =& $args[2];
$handlerFile = $this->getHandlerPath() . '/' . 'PLNHandler.inc.php';
}
}
}
}
/**
* @copydoc PKPPlugin::manage()
*/
function manage($args, $request) {
$journal = $request->getJournal();
switch($request->getUserVar('verb')) {
case 'settings':
$context = $request->getContext();
AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON, LOCALE_COMPONENT_PKP_MANAGER);
$templateMgr = TemplateManager::getManager($request);
$templateMgr->register_function('plugin_url', array($this, 'smartyPluginUrl'));
$this->import('classes/form/PLNSettingsForm');
$form = new PLNSettingsForm($this, $context->getId());
if ($request->getUserVar('refresh')) {
$this->getServiceDocument($context->getId(), $request);
} else {
if ($request->getUserVar('save')) {
$form->readInputData();
if ($form->validate()) {
$form->execute();
// Add notification: Changes saved
$notificationContent = __('plugins.generic.pln.settings.saved');
$currentUser = $request->getUser();
$notificationMgr = new NotificationManager();
$notificationMgr->createTrivialNotification($currentUser->getId(), NOTIFICATION_TYPE_SUCCESS, array('contents' => $notificationContent));
return new JSONMessage(false);
}
}
}
$form->initData();
return new JSONMessage(true, $form->fetch($request));
case 'status':
$depositDao = DAORegistry::getDAO('DepositDAO');
$context = $request->getContext();
AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON, LOCALE_COMPONENT_PKP_MANAGER);
$templateMgr = TemplateManager::getManager($request);
$templateMgr->register_function('plugin_url', array($this, 'smartyPluginUrl'));
$this->import('classes.form.PLNStatusForm');
$form = new PLNStatusForm($this, $context->getId());
if ($request->getUserVar('reset')) {
$deposit_ids = array_keys($request->getUserVar('reset'));
$depositDao = DAORegistry::getDAO('DepositDAO');
foreach ($deposit_ids as $deposit_id) {
$deposit = $depositDao->getById($deposit_id);
$deposit->setStatus(PLN_PLUGIN_DEPOSIT_STATUS_NEW);
$depositDao->updateObject($deposit);
}
}
return new JSONMessage(true, $form->fetch($request));
case 'enable':
if(!@include_once('Archive/Tar.php')) {
$message = NOTIFICATION_TYPE_ERROR;
$messageParams = array('contents' => __('plugins.generic.pln.notifications.archive_tar_missing'));
break;
}
if(!$this->curlInstalled()) {
$message = NOTIFICATION_TYPE_ERROR;
$messageParams = array('contents' => __('plugins.generic.pln.notifications.curl_missing'));
break;
}
if(!$this->zipInstalled()) {
$message = NOTIFICATION_TYPE_ERROR;
$messageParams = array('contents' => __('plugins.generic.pln.notifications.zip_missing'));
break;
}
if(!$this->tarInstalled()) {
$message = NOTIFICATION_TYPE_ERROR;
$messageParams = array('contents' => __('plugins.generic.pln.notifications.tar_missing'));
break;
}
$message = NOTIFICATION_TYPE_SUCCESS;
$messageParams = array('contents' => __('plugins.generic.pln.enabled'));
$this->updateSetting($journal->getId(), 'enabled', true);
break;
case 'disable':
$message = NOTIFICATION_TYPE_SUCCESS;
$messageParams = array('contents' => __('plugins.generic.pln.disabled'));
$this->updateSetting($journal->getId(), 'enabled', false);
break;
default:
return parent::manage($verb, $args, $message, $messageParams);
}
}
/**
* @copydoc GenericPlugin::getManagementVerbs()
*/
function getManagementVerbs() {
$verbs = parent::getManagementVerbs();
if ($this->getEnabled()) {
$verbs[] = array('settings', __('plugins.generic.pln.settings'));
$verbs[] = array('status', __('plugins.generic.pln.status'));
}
return $verbs;
}
/**
* Extend the {url ...} smarty to support this plugin.
* @copydoc Plugin::smartyPluginUrl
*/
function smartyPluginUrl($params, $smarty) {
if (!empty($params['id'])) {
$params['path'] = array_merge($params['path'], array($params['id']));
unset($params['id']);
}
return $smarty->smartyUrl($params, $smarty);
}
/**
* Set the page's breadcrumbs, given the plugin's tree of items
* to append.
* @param $page string
*/
function setBreadcrumbs($page) {
$templateMgr = TemplateManager::getManager();
$pageCrumbs = array(
array(
Request::url(null, 'user'),
'navigation.user'
),
array(
Request::url(null, 'manager'),
'manager.journalManagement'
),
array(
Request::url(null, 'manager', 'plugins'),
'manager.plugins.pluginManagement'
),
array(
Request::url(null, 'manager', 'plugins', 'generic'),
'plugins.categories.generic'
)
);
$templateMgr->assign('pageHierarchy', $pageCrumbs);
}
/**
* Check to see whether the PLN's terms have been agreed to
* to append.
* @param $journalId int
* @return boolean
*/
function termsAgreed($journalId) {
$terms = unserialize($this->getSetting($journalId, 'terms_of_use'));
$termsAgreed = unserialize($this->getSetting($journalId, 'terms_of_use_agreement'));
foreach (array_keys($terms) as $term) {
if (!isset($termsAgreed[$term]) || (!$termsAgreed[$term]))
return false;
}
return true;
}
/**
* Request service document at specified URL
* @param $contextId int The journal id for the service document we wish to fetch
* @return int The HTTP response status or FALSE for a network error.
*/
function getServiceDocument($contextId) {
$request = PKPApplication::getRequest();
$contextDao = Application::getContextDAO();
$context = $contextDao->getById($contextId);
// get the journal and determine the language.
$locale = $context->getPrimaryLocale();
$language = strtolower(str_replace('_', '-', $locale));
$network = $this->getSetting($context->getId(), 'pln_network');
$application = Application::getApplication();
$dispatcher = $application->getDispatcher();
// retrieve the service document
$result = $this->_curlGet(
$network . PLN_PLUGIN_SD_IRI,
array(
'On-Behalf-Of: ' . $this->getSetting($contextId, 'journal_uuid'),
'Journal-URL: ' . $dispatcher->url($request, ROUTE_PAGE, $context->getPath()),
'Accept-language:' . $language,
)
);
// stop here if we didn't get an OK
if ($result['status'] != PLN_PLUGIN_HTTP_STATUS_OK) {
if($result['status'] === FALSE) {
error_log(__('plugins.generic.pln.error.network.servicedocument', array('error' => $result['error'])));
} else {
error_log(__('plugins.generic.pln.error.http.servicedocument', array('error' => $result['status'])));
}
return $result['status'];
}
$serviceDocument = new DOMDocument();
$serviceDocument->preserveWhiteSpace = false;
$serviceDocument->loadXML($result['result']);
// update the max upload size
$element = $serviceDocument->getElementsByTagName('maxUploadSize')->item(0);
$this->updateSetting($contextId, 'max_upload_size', $element->nodeValue);
// update the checksum type
$element = $serviceDocument->getElementsByTagName('uploadChecksumType')->item(0);
$this->updateSetting($contextId, 'checksum_type', $element->nodeValue);
// update the network status
$element = $serviceDocument->getElementsByTagName('pln_accepting')->item(0);
$this->updateSetting($contextId, 'pln_accepting', (($element->getAttribute('is_accepting') == 'Yes') ? true : false));
$this->updateSetting($contextId, 'pln_accepting_message', $element->nodeValue);
// update the terms of use
$termElements = $serviceDocument->getElementsByTagName('terms_of_use')->item(0)->childNodes;
$terms = array();
foreach($termElements as $termElement) {
$terms[$termElement->tagName] = array('updated' => $termElement->getAttribute('updated'), 'term' => $termElement->nodeValue);
}
$newTerms = serialize($terms);
$oldTerms = $this->getSetting($contextId,'terms_of_use');
// if the new terms don't match the exiting ones we need to reset agreement
if ($newTerms != $oldTerms) {
$termAgreements = array();
foreach($terms as $termName => $termText) {
$termAgreements[$termName] = null;
}
$this->updateSetting($contextId, 'terms_of_use', $newTerms, 'object');
$this->updateSetting($contextId, 'terms_of_use_agreement', serialize($termAgreements), 'object');
$this->createJournalManagerNotification($contextId, PLN_PLUGIN_NOTIFICATION_TYPE_TERMS_UPDATED);
}
return $result['status'];
}
/**
* Create notification for all journal managers
* @param $contextId int
* @param $notificationType int
*/
function createJournalManagerNotification($contextId, $notificationType) {
$roleDao = DAORegistry::getDAO('RoleDAO');
$journalManagers = $roleDao->getUsersByRoleId(ROLE_ID_MANAGER, $contextId);
import('classes.notification.NotificationManager');
$notificationManager = new NotificationManager();
// TODO: this currently gets sent to all journal managers - perhaps only limit to the technical contact's account?
while ($journalManager = $journalManagers->next()) {
$notificationManager->createTrivialNotification($journalManager->getId(), $notificationType);
unset($journalManager);
}
}
/**
* Get whether curl is available
* @return boolean
*/
function curlInstalled() {
return function_exists('curl_version');
}
/**
* Get whether zip archive support is present
* @return boolean
*/
function zipInstalled() {
return class_exists('ZipArchive');
}
/**
* Check if the Archive_Tar extension is installed and available. BagIt
* requires it, and will not function without it.
*
* @return boolean
*/
function tarInstalled() {
@include_once('Archive/Tar.php');
return class_exists('Archive_Tar');
}
/**
* Check if acron is enabled, or if the scheduled_tasks config var is set.
* The plugin needs to run periodically through one of those systems.
*
* @return boolean
*/
function cronEnabled() {
$application = PKPApplication::getApplication();
$products = $application->getEnabledProducts('plugins.generic');
return isset($products['acron']) || Config::getVar('general', 'scheduled_tasks', false);
}
/**
* Get resource using CURL
* @param $url string
* @param $headers array
* @return array
*/
function _curlGet($url, $headers=array()) {
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_URL => $url
));
if ($httpProxyHost = Config::getVar('proxy', 'http_host')) {
curl_setopt($curl, CURLOPT_PROXY, $httpProxyHost);
curl_setopt($curl, CURLOPT_PROXYPORT, Config::getVar('proxy', 'http_port', '80'));
if ($username = Config::getVar('proxy', 'username')) {
curl_setopt($curl, CURLOPT_PROXYUSERPWD, $username . ':' . Config::getVar('proxy', 'password'));
}
}
$httpResult = curl_exec($curl);
$httpStatus = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$httpError = curl_error($curl);
curl_close ($curl);
return array(
'status' => $httpStatus,
'result' => $httpResult,
'error' => $httpError
);
}
/**
* Post a file to a resource using CURL
* @param $url string
* @param $headers array
* @return array
*/
function _curlPostFile($url, $filename) {
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => array("Content-Length: " . filesize($filename)),
CURLOPT_INFILE => fopen($filename, "r"),
CURLOPT_INFILESIZE => filesize($filename),
CURLOPT_URL => $url
));
if ($httpProxyHost = Config::getVar('proxy', 'http_host')) {
curl_setopt($curl, CURLOPT_PROXY, $httpProxyHost);
curl_setopt($curl, CURLOPT_PROXYPORT, Config::getVar('proxy', 'http_port', '80'));
if ($username = Config::getVar('proxy', 'username')) {
curl_setopt($curl, CURLOPT_PROXYUSERPWD, $username . ':' . Config::getVar('proxy', 'password'));
}
}
$httpResult = curl_exec($curl);
$httpStatus = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$httpError = curl_error($curl);
curl_close ($curl);
return array(
'status' => $httpStatus,
'result' => $httpResult,
'error' => $httpError
);
}
/**
* Put a file to a resource using CURL
* @param $url string
* @param $filename string
* @return array
*/
function _curlPutFile($url,$filename) {
$headers = array (
"Content-Type: ".mime_content_type($filename),
"Content-Length: ".filesize($filename)
);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_PUT => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_INFILE => fopen($filename, "r"),
CURLOPT_INFILESIZE => filesize($filename),
CURLOPT_URL => $url
));
if ($httpProxyHost = Config::getVar('proxy', 'http_host')) {
curl_setopt($curl, CURLOPT_PROXY, $httpProxyHost);
curl_setopt($curl, CURLOPT_PROXYPORT, Config::getVar('proxy', 'http_port', '80'));
if ($username = Config::getVar('proxy', 'username')) {
curl_setopt($curl, CURLOPT_PROXYUSERPWD, $username . ':' . Config::getVar('proxy', 'password'));
}
}
$httpResult = curl_exec($curl);
$httpStatus = curl_getinfo($curl, CURLINFO_HTTP_CODE);
$httpError = curl_error($curl);
curl_close ($curl);
return array(
'status' => $httpStatus,
'result' => $httpResult,
'error' => $httpError
);
}
/**
* Create a new UUID
* @return string
*/
function newUUID() {
return PKPString::generateUUID();
}
}