first commit
This commit is contained in:
CHIEFSOFT\ameye
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,339 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
@@ -0,0 +1,11 @@
|
||||
# COUNTER Reports classes
|
||||
|
||||
Convenience interface to PHP's DOMDocument for the Project COUNTER schema
|
||||
|
||||
Copyright 2015 (c) University of Pittsburgh
|
||||
|
||||
Licensed under GPL 2.0 or later
|
||||
|
||||
## DESCRIPTION
|
||||
|
||||
See the PHPDoc for COUNTER.php for DESCRIPTION
|
||||
@@ -0,0 +1,364 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file plugins/reports/counter/classes/CounterReport.php
|
||||
*
|
||||
* Copyright (c) 2014 University of Pittsburgh
|
||||
* Distributed under the GNU GPL v2 or later. For full terms see the file docs/COPYING.
|
||||
*
|
||||
* @class CounterReport
|
||||
*
|
||||
* @ingroup plugins_reports_counter
|
||||
*
|
||||
* @brief A COUNTER report, base class
|
||||
*/
|
||||
|
||||
namespace APP\plugins\reports\counter\classes;
|
||||
|
||||
require_once(dirname(__FILE__, 2) . '/classes/COUNTER/COUNTER.php');
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\statistics\StatisticsHelper;
|
||||
use COUNTER\Contact;
|
||||
use COUNTER\Customer;
|
||||
use COUNTER\DateRange;
|
||||
use COUNTER\Metric;
|
||||
use COUNTER\Report;
|
||||
use COUNTER\Reports;
|
||||
use COUNTER\Vendor;
|
||||
use DateTime;
|
||||
use Exception;
|
||||
use PKP\core\PKPString;
|
||||
use PKP\db\DBResultRange;
|
||||
|
||||
define('COUNTER_EXCEPTION_WARNING', 0);
|
||||
define('COUNTER_EXCEPTION_ERROR', 1);
|
||||
define('COUNTER_EXCEPTION_PARTIAL_DATA', 4);
|
||||
define('COUNTER_EXCEPTION_NO_DATA', 8);
|
||||
define('COUNTER_EXCEPTION_BAD_COLUMNS', 16);
|
||||
define('COUNTER_EXCEPTION_BAD_FILTERS', 32);
|
||||
define('COUNTER_EXCEPTION_BAD_ORDERBY', 64);
|
||||
define('COUNTER_EXCEPTION_BAD_RANGE', 128);
|
||||
define('COUNTER_EXCEPTION_INTERNAL', 256);
|
||||
|
||||
// COUNTER as of yet is not internationalized and requires English constants
|
||||
define('COUNTER_LITERAL_ARTICLE', 'Article');
|
||||
define('COUNTER_LITERAL_JOURNAL', 'Journal');
|
||||
define('COUNTER_LITERAL_PROPRIETARY', 'Proprietary');
|
||||
|
||||
class CounterReport
|
||||
{
|
||||
public const COUNTER_CLASS_PREFIX = 'CounterReport';
|
||||
/**
|
||||
* @var string $_release A COUNTER release number
|
||||
*/
|
||||
public $_release;
|
||||
|
||||
/**
|
||||
* @var array $_errors An array of accumulated Exceptions
|
||||
*/
|
||||
public $_errors;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param string $release
|
||||
*/
|
||||
public function __construct($release)
|
||||
{
|
||||
$this->_release = $release;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Get the COUNTER Release
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getRelease()
|
||||
{
|
||||
return $this->_release;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the report code
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getCode()
|
||||
{
|
||||
return substr(get_class($this), strlen(self::COUNTER_CLASS_PREFIX));
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the COUNTER metric type for an Statistics file type
|
||||
*
|
||||
* @param string $filetype
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getKeyForFiletype($filetype)
|
||||
{
|
||||
switch ($filetype) {
|
||||
case StatisticsHelper::STATISTICS_FILE_TYPE_HTML:
|
||||
$metricTypeKey = 'ft_html';
|
||||
break;
|
||||
case StatisticsHelper::STATISTICS_FILE_TYPE_PDF:
|
||||
$metricTypeKey = 'ft_pdf';
|
||||
break;
|
||||
case StatisticsHelper::STATISTICS_FILE_TYPE_OTHER:
|
||||
default:
|
||||
$metricTypeKey = 'other';
|
||||
}
|
||||
return $metricTypeKey;
|
||||
}
|
||||
|
||||
/**
|
||||
* Abstract method must be implemented in the child class
|
||||
* Get the report title
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getTitle()
|
||||
{
|
||||
assert(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an OJS metrics request to COUNTER ReportItems
|
||||
* Abstract method must be implemented by subclass
|
||||
*
|
||||
* @param string|array $columns column (aggregation level) selection
|
||||
* @param array $filters report-level filter selection
|
||||
* @param array $orderBy order criteria
|
||||
* @param null|DBResultRange $range paging specification
|
||||
*
|
||||
* @see ReportPlugin::getMetrics for more details on parameters
|
||||
*
|
||||
* @return array ReportItem array
|
||||
*/
|
||||
public function getReportItems($columns = [], $filters = [], $orderBy = [], $range = null)
|
||||
{
|
||||
assert(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array of errors
|
||||
*
|
||||
* @return array of Exceptions
|
||||
*/
|
||||
public function getErrors()
|
||||
{
|
||||
return $this->_errors ? $this->_errors : [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set an errors condition; Proper Exception handling is deferred until the OJS 3.0 Release
|
||||
*
|
||||
* @param Exception $error
|
||||
*/
|
||||
public function setError($error)
|
||||
{
|
||||
if (!$this->_errors) {
|
||||
$this->_errors = [];
|
||||
}
|
||||
array_push($this->_errors, $error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensure that the $filters do not exceed the current Context
|
||||
*
|
||||
* @param array() $filters
|
||||
*
|
||||
* @return array()
|
||||
*/
|
||||
protected function filterForContext($filters)
|
||||
{
|
||||
$request = Application::get()->getRequest();
|
||||
$journal = $request->getContext();
|
||||
$journalId = $journal ? $journal->getId() : '';
|
||||
// If the request context is at the journal level, the dimension context id must be that same journal id
|
||||
if ($journalId) {
|
||||
if (isset($filters['contextIds']) && $filters['contextIds'] != $journalId) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.generic.exception.filter'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
}
|
||||
$filters['contextIds'] = [$journalId];
|
||||
}
|
||||
return $filters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a Year-Month period and array of PerformanceCounters, create a Metric
|
||||
*
|
||||
* @param string $period Date in the format Y-m-01 for month
|
||||
* @param array $counters PerformanceCounter array
|
||||
*
|
||||
* @return Metric
|
||||
*/
|
||||
protected function createMetricByMonth($period, $counters)
|
||||
{
|
||||
$metric = [];
|
||||
try {
|
||||
$metric = new Metric(
|
||||
// Date range for JR1 is beginning of the month to end of the month
|
||||
new DateRange(
|
||||
DateTime::createFromFormat('Y-m-d H:i:s', $period . ' 00:00:00'),
|
||||
DateTime::createFromFormat('Y-m-d H:i:s', substr($period, 0, 8) . date('t', strtotime($period)) . ' 23:59:59')
|
||||
),
|
||||
'Requests',
|
||||
$counters
|
||||
);
|
||||
} catch (Exception $e) {
|
||||
$this->setError($e, COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_INTERNAL);
|
||||
}
|
||||
return $metric;
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct a Reports result containing the provided performance metrics
|
||||
*
|
||||
* @param array $reportItems ReportItem
|
||||
*
|
||||
* @return ?string xml
|
||||
*/
|
||||
public function createXML($reportItems)
|
||||
{
|
||||
$errors = $this->getErrors();
|
||||
$fatal = false;
|
||||
foreach ($errors as $error) {
|
||||
if ($error->getCode() & COUNTER_EXCEPTION_ERROR) {
|
||||
$fatal = true;
|
||||
}
|
||||
}
|
||||
if (!$fatal) {
|
||||
try {
|
||||
$report = new Reports(
|
||||
new Report(
|
||||
PKPString::generateUUID(),
|
||||
$this->getRelease(),
|
||||
$this->getCode(),
|
||||
$this->getTitle(),
|
||||
new Customer(
|
||||
'0', // customer id is unused
|
||||
$reportItems,
|
||||
__('plugins.reports.counter.allCustomers')
|
||||
),
|
||||
new Vendor(
|
||||
$this->getVendorID(),
|
||||
$this->getVendorName(),
|
||||
$this->getVendorContacts(),
|
||||
$this->getVendorWebsiteUrl(),
|
||||
$this->getVendorLogoUrl()
|
||||
)
|
||||
)
|
||||
);
|
||||
} catch (Exception $e) {
|
||||
$this->setError($e, COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_INTERNAL);
|
||||
}
|
||||
if (isset($report)) {
|
||||
return (string) $report;
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Vendor Id
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getVendorId()
|
||||
{
|
||||
return $this->_getVendorComponent('id');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Vendor Name
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getVendorName()
|
||||
{
|
||||
return (string) $this->_getVendorComponent('name');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Vendor Contacts
|
||||
*
|
||||
* @return array() Contact
|
||||
*/
|
||||
public function getVendorContacts()
|
||||
{
|
||||
return $this->_getVendorComponent('contacts');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Vendor Website URL
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getVendorWebsiteUrl()
|
||||
{
|
||||
return $this->_getVendorComponent('website');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Vendor Contacts
|
||||
*
|
||||
* @return array Contact
|
||||
*/
|
||||
public function getVendorLogoUrl()
|
||||
{
|
||||
return $this->_getVendorComponent('logo');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Vendor Component by key
|
||||
*
|
||||
* @param string $key
|
||||
*/
|
||||
public function _getVendorComponent($key)
|
||||
{
|
||||
$request = Application::get()->getRequest();
|
||||
$site = $request->getSite();
|
||||
$context = $request->getContext();
|
||||
$contextDao = Application::getContextDAO();
|
||||
$availableContexts = $contextDao->getAvailable();
|
||||
[$firstContext, $secondContext] = [$availableContexts->next(), $availableContexts->next()];
|
||||
switch ($key) {
|
||||
case 'name':
|
||||
if ($secondContext) { // Multiple contexts
|
||||
$name = $site->getLocalizedTitle();
|
||||
} else {
|
||||
$name = $context->getData('publisherInstitution');
|
||||
if (empty($name)) {
|
||||
$name = $context->getLocalizedName();
|
||||
}
|
||||
}
|
||||
return $name;
|
||||
case 'id':
|
||||
return $request->getBaseUrl();
|
||||
case 'contacts':
|
||||
try {
|
||||
if ($secondContext) { // Multiple contexts
|
||||
$contactName = $site->getLocalizedContactName();
|
||||
$contactEmail = $site->getLocalizedContactEmail();
|
||||
} else {
|
||||
$contactName = $context->getContactName();
|
||||
$contactEmail = $context->getContactEmail();
|
||||
}
|
||||
$contact = new Contact($contactName, $contactEmail);
|
||||
} catch (Exception $e) {
|
||||
$this->setError($e);
|
||||
$contact = [];
|
||||
}
|
||||
return $contact;
|
||||
case 'website':
|
||||
return $request->getBaseUrl();
|
||||
case 'logo':
|
||||
return '';
|
||||
default:
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,221 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file plugins/reports/counter/classes/reports/CounterReportAR1.php
|
||||
*
|
||||
* Copyright (c) 2014 University of Pittsburgh
|
||||
* Distributed under the GNU GPL v2 or later. For full terms see the file docs/COPYING.
|
||||
*
|
||||
* @class CounterReportAR1
|
||||
*
|
||||
* @brief Article Report 1
|
||||
*/
|
||||
|
||||
namespace APP\plugins\reports\counter\classes\reports;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\core\Services;
|
||||
use APP\facades\Repo;
|
||||
use APP\journal\JournalDAO;
|
||||
use APP\plugins\reports\counter\classes\CounterReport;
|
||||
use APP\statistics\StatisticsHelper;
|
||||
use COUNTER\Identifier;
|
||||
use COUNTER\ParentItem;
|
||||
use COUNTER\PerformanceCounter;
|
||||
use COUNTER\ReportItems;
|
||||
use Exception;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\db\DBResultRange;
|
||||
use PKP\plugins\PluginRegistry;
|
||||
|
||||
class CounterReportAR1 extends CounterReport
|
||||
{
|
||||
/**
|
||||
* Get the report title
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getTitle()
|
||||
{
|
||||
return __('plugins.reports.counter.ar1.title');
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an OJS metrics request to a COUNTER ReportItem
|
||||
*
|
||||
* @param string|array $columns column (aggregation level) selection
|
||||
* @param array $filters report-level filter selection
|
||||
* @param array $orderBy order criteria
|
||||
* @param null|DBResultRange $range paging specification
|
||||
*
|
||||
* @see ReportPlugin::getMetrics for more details
|
||||
*
|
||||
* @return array ReportItem
|
||||
*/
|
||||
public function getReportItems($columns = [], $filters = [], $orderBy = [], $range = null)
|
||||
{
|
||||
// Columns are fixed for this report
|
||||
$defaultColumns = [StatisticsHelper::STATISTICS_DIMENSION_MONTH, StatisticsHelper::STATISTICS_DIMENSION_SUBMISSION_ID];
|
||||
if ($columns && array_diff($columns, $defaultColumns)) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.column'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_COLUMNS));
|
||||
}
|
||||
// Check filters for correct context(s)
|
||||
$validFilters = $this->filterForContext($filters);
|
||||
// Filters defaults to last month, but can be provided by month or by day (which is defined in the $columns)
|
||||
if (!isset($filters['dateStart']) && !isset($filters['dateEnd'])) {
|
||||
$validFilters['dateStart'] = date_format(date_create('first day of previous month'), 'Ymd');
|
||||
$validFilters['dateEnd'] = date_format(date_create('last day of previous month'), 'Ymd');
|
||||
} elseif (!isset($filters['dateStart']) || !isset($filters['dateEnd'])) {
|
||||
// either start or end date not set
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.filter'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
} elseif (isset($filters['dateStart']) && isset($filters['dateEnd'])) {
|
||||
$validFilters['dateStart'] = $filters['dateStart'];
|
||||
$validFilters['dateEnd'] = $filters['dateEnd'];
|
||||
unset($filters['dateStart']);
|
||||
unset($filters['dateEnd']);
|
||||
}
|
||||
if (!isset($filters['assocTypes'])) {
|
||||
$validFilters['assocTypes'] = [Application::ASSOC_TYPE_SUBMISSION_FILE];
|
||||
unset($filters['assocTypes']);
|
||||
} elseif ($filters['assocTypes'] != Application::ASSOC_TYPE_SUBMISSION_FILE) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.filter'), COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
}
|
||||
// AR1 could be filtered to the Journal, Issue, or Article level
|
||||
foreach ($filters as $key => $filter) {
|
||||
switch ($key) {
|
||||
case 'contextIds':
|
||||
case 'issueIds':
|
||||
case 'submissionIds':
|
||||
$validFilters[$key] = [$filter];
|
||||
unset($filters[$key]);
|
||||
}
|
||||
}
|
||||
// Unrecognized filters raise an error
|
||||
if (array_keys($filters)) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.filter'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
}
|
||||
// Identify submissions which should be included in the results when issue IDs are passed
|
||||
if (isset($validFilters['issueIds'])) {
|
||||
$submissionIds = isset($validFilters['submissionIds']) ?? [];
|
||||
$issueIdsSubmissionIds = Repo::submission()
|
||||
->getCollector()
|
||||
->filterByContextIds([Application::get()->getRequest()->getContext()->getId()])
|
||||
->filterByStatus([\APP\submission\Submission::STATUS_PUBLISHED])
|
||||
->filterByIssueIds($validFilters['issueIds'])
|
||||
->getIds()
|
||||
->toArray();
|
||||
|
||||
if (!empty($submissionIds)) {
|
||||
$submissionIds = array_intersect($submissionIds, $issueIdsSubmissionIds);
|
||||
} else {
|
||||
$submissionIds = $issueIdsSubmissionIds;
|
||||
}
|
||||
if (!empty($submissionIds)) {
|
||||
$validFilters['submissionIds'] = $submissionIds;
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.noData'), COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_NO_DATA));
|
||||
return [];
|
||||
}
|
||||
}
|
||||
// TODO: range
|
||||
$results = Services::get('publicationStats')
|
||||
->getQueryBuilder($validFilters)
|
||||
->getSum($defaultColumns)
|
||||
->orderBy(StatisticsHelper::STATISTICS_DIMENSION_SUBMISSION_ID, StatisticsHelper::STATISTICS_ORDER_DESC)
|
||||
->orderBy(StatisticsHelper::STATISTICS_DIMENSION_MONTH, StatisticsHelper::STATISTICS_ORDER_ASC)
|
||||
->get()->toArray();
|
||||
$reportItems = [];
|
||||
if ($results) {
|
||||
// We'll create a new Report Item with these Metrics on a article change
|
||||
$metrics = [];
|
||||
$lastArticle = 0;
|
||||
foreach ($results as $rs) {
|
||||
// Article changes trigger a new ReportItem
|
||||
if ($lastArticle != $rs->{StatisticsHelper::STATISTICS_DIMENSION_SUBMISSION_ID}) {
|
||||
if ($lastArticle != 0 && $metrics) {
|
||||
$item = $this->_createReportItem($lastArticle, $metrics);
|
||||
if ($item) {
|
||||
$reportItems[] = $item;
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.partialData'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_PARTIAL_DATA));
|
||||
}
|
||||
$metrics = [];
|
||||
}
|
||||
}
|
||||
$metrics[] = $this->createMetricByMonth($rs->{StatisticsHelper::STATISTICS_DIMENSION_MONTH}, [new PerformanceCounter('ft_total', $rs->{StatisticsHelper::STATISTICS_METRIC})]);
|
||||
$lastArticle = $rs->{StatisticsHelper::STATISTICS_DIMENSION_SUBMISSION_ID};
|
||||
}
|
||||
// Capture the last unprocessed ItemPerformance and ReportItem entries, if applicable
|
||||
if ($metrics) {
|
||||
$item = $this->_createReportItem($lastArticle, $metrics);
|
||||
if ($item) {
|
||||
$reportItems[] = $item;
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.partialData'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_PARTIAL_DATA));
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.noData'), COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_NO_DATA));
|
||||
}
|
||||
return $reportItems;
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a submissionId and an array of Metrics, return a ReportItems
|
||||
*
|
||||
* @param int $submissionId
|
||||
* @param array $metrics Metric array
|
||||
*
|
||||
* @return mixed ReportItems or false
|
||||
*/
|
||||
private function _createReportItem($submissionId, $metrics)
|
||||
{
|
||||
$article = Repo::submission()->get($submissionId);
|
||||
if (!$article) {
|
||||
return false;
|
||||
}
|
||||
$title = $article->getCurrentPublication()->getLocalizedTitle();
|
||||
$journalId = $article->getData('contextId');
|
||||
$journalDao = DAORegistry::getDAO('JournalDAO'); /** @var JournalDAO $journalDao */
|
||||
$journal = $journalDao->getById($journalId);
|
||||
if (!$journal) {
|
||||
return false;
|
||||
}
|
||||
$journalName = $journal->getLocalizedName();
|
||||
$journalPubIds = [];
|
||||
foreach (['print', 'online'] as $issnType) {
|
||||
if ($journal->getData($issnType . 'Issn')) {
|
||||
try {
|
||||
$journalPubIds[] = new Identifier(ucfirst($issnType) . '_ISSN', $journal->getData($issnType . 'Issn'));
|
||||
} catch (Exception $ex) {
|
||||
// Just ignore it
|
||||
}
|
||||
}
|
||||
}
|
||||
$journalPubIds[] = new Identifier(COUNTER_LITERAL_PROPRIETARY, $journal->getPath());
|
||||
$pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $journalId);
|
||||
$articlePubIds = [];
|
||||
$articlePubIds[] = new Identifier(COUNTER_LITERAL_PROPRIETARY, (string) $submissionId);
|
||||
if ($doi = $article->getCurrentPublication()->getDoi()) {
|
||||
try {
|
||||
$articlePubIds[] = new Identifier(strtoupper('doi'), $doi);
|
||||
} catch (Exception $ex) {
|
||||
// Just ignore it
|
||||
}
|
||||
}
|
||||
$reportItem = [];
|
||||
try {
|
||||
$reportItem = new ReportItems(
|
||||
__('common.software'),
|
||||
$title,
|
||||
COUNTER_LITERAL_ARTICLE,
|
||||
$metrics,
|
||||
new ParentItem($journalName, COUNTER_LITERAL_JOURNAL, $journalPubIds),
|
||||
$articlePubIds
|
||||
);
|
||||
} catch (Exception $e) {
|
||||
$this->setError($e, COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_INTERNAL);
|
||||
}
|
||||
return $reportItem;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,178 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file plugins/reports/counter/classes/reports/CounterReportJR1.php
|
||||
*
|
||||
* Copyright (c) 2014 University of Pittsburgh
|
||||
* Distributed under the GNU GPL v2 or later. For full terms see the file docs/COPYING.
|
||||
*
|
||||
* @class CounterReportJR1
|
||||
*
|
||||
* @brief Journal Report 1
|
||||
*/
|
||||
|
||||
namespace APP\plugins\reports\counter\classes\reports;
|
||||
|
||||
use APP\core\Application;
|
||||
use APP\core\Services;
|
||||
use APP\journal\JournalDAO;
|
||||
use APP\plugins\reports\counter\classes\CounterReport;
|
||||
use APP\statistics\StatisticsHelper;
|
||||
use COUNTER\Identifier;
|
||||
use COUNTER\PerformanceCounter;
|
||||
use COUNTER\ReportItems;
|
||||
use Exception;
|
||||
use PKP\db\DAORegistry;
|
||||
use PKP\db\DBResultRange;
|
||||
|
||||
class CounterReportJR1 extends CounterReport
|
||||
{
|
||||
/**
|
||||
* Get the report title
|
||||
*
|
||||
* @return $string
|
||||
*/
|
||||
public function getTitle()
|
||||
{
|
||||
return __('plugins.reports.counter.jr1.title');
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert an OJS metrics request to COUNTER ReportItems
|
||||
*
|
||||
* @param string|array $columns column (aggregation level) selection
|
||||
* @param array $filters report-level filter selection
|
||||
* @param array $orderBy order criteria
|
||||
* @param null|DBResultRange $range paging specification
|
||||
*
|
||||
* @see ReportPlugin::getMetrics for more details
|
||||
*
|
||||
* @return array COUNTER\ReportItem array
|
||||
*/
|
||||
public function getReportItems($columns = [], $filters = [], $orderBy = [], $range = null)
|
||||
{
|
||||
// Columns are fixed for this report
|
||||
$defaultColumns = [StatisticsHelper::STATISTICS_DIMENSION_CONTEXT_ID, StatisticsHelper::STATISTICS_DIMENSION_FILE_TYPE, StatisticsHelper::STATISTICS_DIMENSION_MONTH];
|
||||
if ($columns && array_diff($columns, $defaultColumns)) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.column'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_COLUMNS));
|
||||
}
|
||||
// Check filters for correct context(s)
|
||||
$validFilters = $this->filterForContext($filters);
|
||||
// Filters defaults to last month, but can be provided by month or by day (which is defined in the $columns)
|
||||
if (!isset($filters['dateStart']) && !isset($filters['dateEnd'])) {
|
||||
$validFilters['dateStart'] = date_format(date_create('first day of previous month'), 'Ymd');
|
||||
$validFilters['dateEnd'] = date_format(date_create('last day of previous month'), 'Ymd');
|
||||
} elseif (!isset($filters['dateStart']) || !isset($filters['dateEnd'])) {
|
||||
// either start or end date not set
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.filter'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
} elseif (isset($filters['dateStart']) && isset($filters['dateEnd'])) {
|
||||
$validFilters['dateStart'] = $filters['dateStart'];
|
||||
$validFilters['dateEnd'] = $filters['dateEnd'];
|
||||
unset($filters['dateStart']);
|
||||
unset($filters['dateEnd']);
|
||||
}
|
||||
if (!isset($filters['assocTypes'])) {
|
||||
$validFilters['assocTypes'] = [Application::ASSOC_TYPE_SUBMISSION_FILE];
|
||||
unset($filters['assocTypes']);
|
||||
} elseif ($filters['assocTypes'] != Application::ASSOC_TYPE_SUBMISSION_FILE) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.filter'), COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
}
|
||||
// Any further filters aren't recognized (at this time, at least)
|
||||
if (array_keys($filters)) {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.filter'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_BAD_FILTERS));
|
||||
}
|
||||
// TODO: range
|
||||
$results = Services::get('publicationStats')->getQueryBuilder($validFilters)
|
||||
->getSum($defaultColumns)
|
||||
// Ordering must be by Journal (ReportItem), and by Month (ItemPerformance) for JR1
|
||||
->orderBy(StatisticsHelper::STATISTICS_DIMENSION_CONTEXT_ID, StatisticsHelper::STATISTICS_ORDER_DESC)
|
||||
->orderBy(StatisticsHelper::STATISTICS_DIMENSION_MONTH, StatisticsHelper::STATISTICS_ORDER_ASC)
|
||||
->get()->toArray();
|
||||
$reportItems = [];
|
||||
if ($results) {
|
||||
// We'll create a new Report Item with these Metrics on a journal change
|
||||
$metrics = [];
|
||||
// We'll create a new Metric with these Performance Counters on a period change
|
||||
$counters = [];
|
||||
$lastPeriod = 0;
|
||||
$lastJournal = 0;
|
||||
foreach ($results as $rs) {
|
||||
// Identify the type of request
|
||||
$metricTypeKey = $this->getKeyForFiletype($rs->{StatisticsHelper::STATISTICS_DIMENSION_FILE_TYPE});
|
||||
// Period changes or greater trigger a new ItemPerformace metric
|
||||
if ($lastPeriod != $rs->{StatisticsHelper::STATISTICS_DIMENSION_MONTH} || $lastJournal != $rs->{StatisticsHelper::STATISTICS_DIMENSION_CONTEXT_ID}) {
|
||||
if ($lastPeriod != 0) {
|
||||
$metrics[] = $this->createMetricByMonth($lastPeriod, $counters);
|
||||
$counters = [];
|
||||
}
|
||||
}
|
||||
$lastPeriod = $rs->{StatisticsHelper::STATISTICS_DIMENSION_MONTH};
|
||||
$counters[] = new PerformanceCounter($metricTypeKey, $rs->{StatisticsHelper::STATISTICS_METRIC});
|
||||
// Journal changes trigger a new ReportItem
|
||||
if ($lastJournal != $rs->{StatisticsHelper::STATISTICS_DIMENSION_CONTEXT_ID}) {
|
||||
if ($lastJournal != 0 && $metrics) {
|
||||
$item = $this->_createReportItem($lastJournal, $metrics);
|
||||
if ($item) {
|
||||
$reportItems[] = $item;
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.partialData'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_PARTIAL_DATA));
|
||||
}
|
||||
$metrics = [];
|
||||
}
|
||||
}
|
||||
$lastJournal = $rs->{StatisticsHelper::STATISTICS_DIMENSION_CONTEXT_ID};
|
||||
}
|
||||
// Capture the last unprocessed ItemPerformance and ReportItem entries, if applicable
|
||||
if ($counters) {
|
||||
$metrics[] = $this->createMetricByMonth($lastPeriod, $counters);
|
||||
}
|
||||
if ($metrics) {
|
||||
$item = $this->_createReportItem($lastJournal, $metrics);
|
||||
if ($item) {
|
||||
$reportItems[] = $item;
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.partialData'), COUNTER_EXCEPTION_WARNING | COUNTER_EXCEPTION_PARTIAL_DATA));
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$this->setError(new Exception(__('plugins.reports.counter.exception.noData'), COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_NO_DATA));
|
||||
}
|
||||
return $reportItems;
|
||||
}
|
||||
|
||||
/**
|
||||
* Given a journalId and an array of COUNTER\Metrics, return a COUNTER\ReportItems
|
||||
*
|
||||
* @param int $journalId
|
||||
* @param array $metrics COUNTER\Metric array
|
||||
*
|
||||
* @return mixed COUNTER\ReportItems or false
|
||||
*/
|
||||
private function _createReportItem($journalId, $metrics)
|
||||
{
|
||||
$journalDao = DAORegistry::getDAO('JournalDAO'); /** @var JournalDAO $journalDao */
|
||||
$journal = $journalDao->getById($journalId);
|
||||
if (!$journal) {
|
||||
return false;
|
||||
}
|
||||
$journalName = $journal->getLocalizedName();
|
||||
$journalPubIds = [];
|
||||
foreach (['print', 'online'] as $issnType) {
|
||||
if ($journal->getData($issnType . 'Issn')) {
|
||||
try {
|
||||
$journalPubIds[] = new Identifier(ucfirst($issnType) . '_ISSN', $journal->getData($issnType . 'Issn'));
|
||||
} catch (Exception $ex) {
|
||||
// Just ignore it
|
||||
}
|
||||
}
|
||||
}
|
||||
$journalPubIds[] = new Identifier(COUNTER_LITERAL_PROPRIETARY, $journal->getPath());
|
||||
$reportItem = [];
|
||||
try {
|
||||
$reportItem = new ReportItems(__('common.software'), $journalName, COUNTER_LITERAL_JOURNAL, $metrics, null, $journalPubIds);
|
||||
} catch (Exception $e) {
|
||||
$this->setError($e, COUNTER_EXCEPTION_ERROR | COUNTER_EXCEPTION_INTERNAL);
|
||||
}
|
||||
return $reportItem;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user