-
Notifications
You must be signed in to change notification settings - Fork 8
/
LensGalleyBitsPlugin.inc.php
executable file
·314 lines (286 loc) · 9.16 KB
/
LensGalleyBitsPlugin.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
<?php
/**
* @file plugins/generic/lensGalleyBits/LensGalleyBitsPlugin.inc.php
*
* Copyright (c) 2014-2018 Simon Fraser University
* Copyright (c) 2003-2018 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class LensGalleyPlugin
* @ingroup plugins_generic_lensGalley
*
* @brief Class for lensGalleyBits plugin
*/
import('lib.pkp.classes.plugins.GenericPlugin');
class LensGalleyBitsPlugin extends GenericPlugin {
/**
* @copydoc LazyLoadPlugin::register()
*/
function register($category, $path, $mainContextId = null) {
if (parent::register($category, $path, $mainContextId)) {
if ($this->getEnabled()) {
HookRegistry::register('ArticleHandler::view::galley', array($this, 'articleCallback'));
HookRegistry::register('IssueHandler::view::galley', array($this, 'issueCallback'));
HookRegistry::register('ArticleHandler::download', array($this, 'articleDownloadCallback'), HOOK_SEQUENCE_LATE);
}
return true;
}
return false;
}
/**
* Install default settings on journal creation.
* @return string
*/
function getContextSpecificPluginSettingsFile() {
return $this->getPluginPath() . '/settings.xml';
}
/**
* Get the display name of this plugin.
* @return String
*/
function getDisplayName() {
return __('plugins.generic.lensGalleyBits.displayName');
}
/**
* Get a description of the plugin.
*/
function getDescription() {
return __('plugins.generic.lensGalleyBits.description');
}
/**
* Callback that renders the article galley.
* @param $hookName string
* @param $args array
* @return boolean
*/
function articleCallback($hookName, $args) {
$request =& $args[0];
$issue =& $args[1];
$galley =& $args[2];
$article =& $args[3];
$templateMgr = TemplateManager::getManager($request);
if ($galley && in_array($galley->getFileType(), array('application/xml', 'text/xml'))) {
$templateMgr->assign(array(
'pluginLensPath' => $this->getLensPath($request),
'displayTemplatePath' => $this->getTemplateResource('display.tpl'),
'pluginUrl' => $request->getBaseUrl() . '/' . $this->getPluginPath(),
'galleyFile' => $galley->getFile(),
'issue' => $issue,
'article' => $article,
'galley' => $galley,
'jQueryUrl' => $this->_getJQueryUrl($request),
));
$templateMgr->display($this->getTemplateResource('articleGalley.tpl'));
return true;
}
return false;
}
/**
* Callback that renders the issue galley.
* @param $hookName string
* @param $args array
* @return boolean
*/
function issueCallback($hookName, $args) {
$request =& $args[0];
$issue =& $args[1];
$galley =& $args[2];
$templateMgr = TemplateManager::getManager($request);
if ($galley && $galley->getFileType() == 'application/xml') {
$templateMgr->assign(array(
'pluginLensPath' => $this->getLensPath($request),
'displayTemplatePath' => $this->getTemplateResource('display.tpl'),
'pluginUrl' => $request->getBaseUrl() . '/' . $this->getPluginPath(),
'galleyFile' => $galley->getFile(),
'issue' => $issue,
'galley' => $galley,
'jQueryUrl' => $this->_getJQueryUrl($request),
));
$templateMgr->addJavaScript(
'jquery',
$jquery,
array(
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'frontend',
)
);
$templateMgr->display($this->getTemplateResource('issueGalley.tpl'));
return true;
}
return false;
}
/**
* Get the URL for JQuery JS.
* @param $request PKPRequest
* @return string
*/
private function _getJQueryUrl($request) {
$min = Config::getVar('general', 'enable_minified') ? '.min' : '';
if (Config::getVar('general', 'enable_cdn')) {
return '//ajax.googleapis.com/ajax/libs/jquery/' . CDN_JQUERY_VERSION . '/jquery' . $min . '.js';
} else {
return $request->getBaseUrl() . '/lib/pkp/lib/components/jquery/jquery' . $min . '.js';
}
}
/**
* returns the base path for Lens JS included in this plugin.
* @param $request PKPRequest
* @return string
*/
function getLensPath($request) {
return $request->getBaseUrl() . '/' . $this->getPluginPath() . '/lib/lens';
}
/**
* Present rewritten XML.
* @param string $hookName
* @param array $args
*/
function articleDownloadCallback($hookName, $args) {
$article =& $args[0];
$galley =& $args[1];
$fileId =& $args[2];
$request = Application::getRequest();
if ($galley && $galley->getFileType() == 'application/xml' && $galley->getFileId() == $fileId) {
if (!HookRegistry::call('LensGalleyPlugin::articleDownload', array($article, &$galley, &$fileId))) {
$xmlContents = $this->_getXMLContents($request, $galley);
header('Content-Type: application/xml');
header('Content-Length: ' . strlen($xmlContents));
header('Content-Disposition: inline');
header('Cache-Control: private');
header('Pragma: public');
echo $xmlContents;
$returner = true;
HookRegistry::call('LensGalleyPlugin::articleDownloadFinished', array(&$returner));
}
return true;
}
return false;
}
/**
* Return string containing the contents of the XML file.
* This function performs any necessary filtering, like image URL replacement.
* @param $request PKPRequest
* @param $galley ArticleGalley
* @return string
*/
function _getXMLContents($request, $galley) {
$journal = $request->getJournal();
$submissionFile = $galley->getFile();
$contents = file_get_contents($submissionFile->getFilePath());
// Replace media file references
$submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO');
import('lib.pkp.classes.submission.SubmissionFile'); // Constants
$embeddableFiles = array_merge(
$submissionFileDao->getLatestRevisions($submissionFile->getSubmissionId(), SUBMISSION_FILE_PROOF),
$submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_SUBMISSION_FILE, $submissionFile->getFileId(), $submissionFile->getSubmissionId(), SUBMISSION_FILE_DEPENDENT)
);
$referredArticle = null;
$articleDao = DAORegistry::getDAO('ArticleDAO');
foreach ($embeddableFiles as $embeddableFile) {
// Ensure that the $referredArticle object refers to the article we want
if (!$referredArticle || $referredArticle->getId() != $galley->getSubmissionId()) {
$referredArticle = $articleDao->getById($galley->getSubmissionId());
}
$fileUrl = $request->url(null, 'article', 'download', array($referredArticle->getBestArticleId(), $galley->getBestGalleyId(), $embeddableFile->getFileId()));
$pattern = preg_quote($embeddableFile->getOriginalFileName());
$contents = preg_replace(
$pattern='/([Ss][Rr][Cc]|[Hh][Rr][Ee][Ff]|[Dd][Aa][Tt][Aa])\s*=\s*"([^"]*' . $pattern . ')"/',
'\1="' . $fileUrl . '"',
$contents
);
}
// Perform replacement for ojs://... URLs
$contents = preg_replace_callback(
'/(<[^<>]*")[Oo][Jj][Ss]:\/\/([^"]+)("[^<>]*>)/',
array($this, '_handleOjsUrl'),
$contents
);
// Perform variable replacement for journal, issue, site info
$issueDao = DAORegistry::getDAO('IssueDAO');
$issue = $issueDao->getByArticleId($galley->getSubmissionId());
$journal = $request->getJournal();
$site = $request->getSite();
$paramArray = array(
'issueTitle' => $issue?$issue->getIssueIdentification():__('editor.article.scheduleForPublication.toBeAssigned'),
'journalTitle' => $journal->getLocalizedName(),
'siteTitle' => $site->getLocalizedTitle(),
'currentUrl' => $request->getRequestUrl()
);
foreach ($paramArray as $key => $value) {
$contents = str_replace('{$' . $key . '}', $value, $contents);
}
return $contents;
}
function _handleOjsUrl($matchArray) {
$request = Application::getRequest();
$url = $matchArray[2];
$anchor = null;
if (($i = strpos($url, '#')) !== false) {
$anchor = substr($url, $i+1);
$url = substr($url, 0, $i);
}
$urlParts = explode('/', $url);
if (isset($urlParts[0])) switch(strtolower_codesafe($urlParts[0])) {
case 'journal':
$url = $request->url(
isset($urlParts[1]) ?
$urlParts[1] :
$request->getRequestedJournalPath(),
null,
null,
null,
null,
$anchor
);
break;
case 'article':
if (isset($urlParts[1])) {
$url = $request->url(
null,
'article',
'view',
$urlParts[1],
null,
$anchor
);
}
break;
case 'issue':
if (isset($urlParts[1])) {
$url = $request->url(
null,
'issue',
'view',
$urlParts[1],
null,
$anchor
);
} else {
$url = $request->url(
null,
'issue',
'current',
null,
null,
$anchor
);
}
break;
case 'sitepublic':
array_shift($urlParts);
import ('classes.file.PublicFileManager');
$publicFileManager = new PublicFileManager();
$url = $request->getBaseUrl() . '/' . $publicFileManager->getSiteFilesPath() . '/' . implode('/', $urlParts) . ($anchor?'#' . $anchor:'');
break;
case 'public':
array_shift($urlParts);
$journal = $request->getJournal();
import ('classes.file.PublicFileManager');
$publicFileManager = new PublicFileManager();
$url = $request->getBaseUrl() . '/' . $publicFileManager->getJournalFilesPath($journal->getId()) . '/' . implode('/', $urlParts) . ($anchor?'#' . $anchor:'');
break;
}
return $matchArray[1] . $url . $matchArray[3];
}
}
?>