Select an article from {{ journal.name }}.
+ + {% if articles %} + + {% else %} +
+
+ {% endif %}
+
+
+ {% endif %}
+
+ No articles found for {{ journal.name }}.
+Hello {{ task.user.first_name }},
\nYour report \"{{ task.report_name }}\" has been generated and is ready for download.
\n\n\nThis report was requested on {{ task.created|date:\"Y-m-d H:i\" }}.
" + } + }, + { + "group": {"name": "email_subject"}, + "setting": { + "name": "subject_deferred_reports_report_ready", + "pretty_name": "Deferred Reports: Report Ready Subject", + "description": "Subject line for the report ready email.", + "type": "char", + "is_translatable": true + }, + "value": { + "default": "Your report is ready: {{ task.report_name }}" + } + }, + { + "group": {"name": "email"}, + "setting": { + "name": "deferred_reports_report_failed", + "pretty_name": "Deferred Reports: Report Failed Email", + "description": "Email sent to a user when their async report has permanently failed.", + "type": "rich-text", + "is_translatable": true + }, + "value": { + "default": "Hello {{ task.user.first_name }},
\nUnfortunately, your report \"{{ task.report_name }}\" could not be generated.
\nError: {{ task.error_message }}
\n\nPlease try again or contact support if the problem persists.
" + } + }, + { + "group": {"name": "email_subject"}, + "setting": { + "name": "subject_deferred_reports_report_failed", + "pretty_name": "Deferred Reports: Report Failed Subject", + "description": "Subject line for the report failed email.", + "type": "char", + "is_translatable": true + }, + "value": { + "default": "Report generation failed: {{ task.report_name }}" + } + } +] diff --git a/management/__init__.py b/management/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/management/commands/__init__.py b/management/commands/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/management/commands/cleanup_old_reports.py b/management/commands/cleanup_old_reports.py new file mode 100644 index 0000000..2380e1a --- /dev/null +++ b/management/commands/cleanup_old_reports.py @@ -0,0 +1,46 @@ +import os +from datetime import timedelta + +from django.core.management.base import BaseCommand +from django.utils import timezone + +from plugins.deferred_reports.models import ReportTask + + +class Command(BaseCommand): + help = ( + 'Deletes report tasks and their CSV files older than a given ' + 'number of days (default: 30).' + ) + + def add_arguments(self, parser): + parser.add_argument( + '--days', + type=int, + default=30, + help='Delete reports older than this many days (default: 30).', + ) + + def handle(self, *args, **options): + days = options['days'] + cutoff = timezone.now() - timedelta(days=days) + + old_tasks = ReportTask.objects.filter(created__lt=cutoff) + count = old_tasks.count() + + for task in old_tasks: + if task.file_path and os.path.exists(task.file_path): + try: + os.remove(task.file_path) + except OSError as e: + self.stderr.write( + f'Could not delete {task.file_path}: {e}', + ) + + old_tasks.delete() + + self.stdout.write( + self.style.SUCCESS( + f'Deleted {count} report(s) older than {days} days.', + ), + ) diff --git a/management/commands/install_cron.py b/management/commands/install_cron.py new file mode 100644 index 0000000..b87ce51 --- /dev/null +++ b/management/commands/install_cron.py @@ -0,0 +1,101 @@ +import os + +from django.conf import settings +from django.core.management.base import BaseCommand + +try: + import crontab +except (ImportError, ModuleNotFoundError): + crontab = None + + +def find_job(tab, comment): + for job in tab: + if job.comment == comment: + return job + return None + + +class Command(BaseCommand): + """ + Installs cron jobs for the Deferred Reports plugin. + """ + + help = "Installs cron jobs for the Deferred Reports plugin." + + def add_arguments(self, parser): + parser.add_argument("--action", default="") + + def handle(self, *args, **options): + if not os.path.isfile("/usr/bin/crontab"): + self.stdout.write( + self.style.WARNING( + "WARNING: /usr/bin/crontab not found, skipping crontab config." + ) + ) + return + + if not crontab: + self.stdout.write( + self.style.WARNING( + "WARNING: crontab module is not installed, skipping crontab config." + ) + ) + return + + action = options.get("action") + tab = crontab.CronTab(user=True) + virtualenv = os.environ.get("VIRTUAL_ENV", None) + + cwd = settings.PROJECT_DIR.replace("/", "_") + + jobs = [ + { + "name": "{}_deferred_reports_process".format(cwd), + "time": 5, + "task": "process_pending_reports", + "type": "mins", + }, + { + "name": "{}_deferred_reports_cleanup".format(cwd), + "time": 3, + "task": "cleanup_old_reports", + "type": "daily", + }, + ] + + for job in jobs: + current_job = find_job(tab, job["name"]) + + if not current_job: + django_command = "{0}/manage.py {1}".format( + settings.BASE_DIR, job["task"] + ) + if virtualenv: + command = "%s/bin/python3 %s" % (virtualenv, django_command) + else: + command = "%s" % (django_command) + + cron_job = tab.new(command, comment=job["name"]) + + if job.get("type") == "daily": + cron_job.setall("0 {} * * *".format(job["time"])) + else: + cron_job.minute.every(job["time"]) + + self.stdout.write( + self.style.SUCCESS( + "Installed cron job: {name}".format(name=job["name"]) + ) + ) + else: + self.stdout.write( + "{name} cron job already exists.".format(name=job["name"]) + ) + + if action == "test": + self.stdout.write(tab.render()) + elif action == "quiet": + pass + else: + tab.write() diff --git a/management/commands/process_pending_reports.py b/management/commands/process_pending_reports.py new file mode 100644 index 0000000..ac54e7d --- /dev/null +++ b/management/commands/process_pending_reports.py @@ -0,0 +1,124 @@ +from datetime import timedelta + +from django.core.management.base import BaseCommand +from django.utils import timezone + +from plugins.deferred_reports.models import ReportTask +from plugins.deferred_reports import email as report_email +from plugins.deferred_reports.execute import execute_report + + +class Command(BaseCommand): + help = ( + 'Processes any report tasks in pending state. ' + 'Intended to be run regularly via cron. ' + 'Tasks stuck in processing for longer than --stuck-after minutes ' + 'are assumed to have crashed and are reset to pending.' + ) + + MAX_ATTEMPTS = 3 + + def add_arguments(self, parser): + parser.add_argument( + '--limit', + type=int, + default=5, + help='Maximum number of reports to process per run (default: 5).', + ) + parser.add_argument( + '--stuck-after', + type=int, + default=10, + help=( + 'Minutes a task can be in processing state before it is ' + 'considered crashed and reset to pending (default: 10).' + ), + ) + + def handle(self, *args, **options): + stuck_after = options['stuck_after'] + cutoff = timezone.now() - timedelta(minutes=stuck_after) + + stuck = ReportTask.objects.filter( + status=ReportTask.STATUS_PROCESSING, + created__lt=cutoff, + ) + if stuck.exists(): + count = stuck.count() + stuck.update(status=ReportTask.STATUS_PENDING) + self.stdout.write( + f'Reset {count} task(s) stuck in processing for ' + f'>{stuck_after} minutes.', + ) + + # Mark exhausted tasks as permanently failed before picking up work. + exhausted = ReportTask.objects.filter( + status=ReportTask.STATUS_PENDING, + attempt_count__gte=self.MAX_ATTEMPTS, + ) + if exhausted.exists(): + count = exhausted.count() + exhausted.update(status=ReportTask.STATUS_FAILED) + self.stdout.write( + self.style.WARNING( + f'Marked {count} task(s) as failed after ' + f'{self.MAX_ATTEMPTS} attempts.', + ) + ) + for task in ReportTask.objects.filter( + status=ReportTask.STATUS_FAILED, + attempt_count__gte=self.MAX_ATTEMPTS, + ): + report_email.send_failure_email(task) + + limit = options['limit'] + pending = ReportTask.objects.filter( + status=ReportTask.STATUS_PENDING, + ).order_by('created')[:limit] + count = len(pending) + + total_pending = ReportTask.objects.filter( + status=ReportTask.STATUS_PENDING, + ).count() + + if not count: + self.stdout.write('No pending report tasks.') + return + + self.stdout.write( + f'Found {total_pending} pending report task(s) total; ' + f'processing {count} (limit: {limit}).', + ) + + for task in pending: + journal_label = f' [{task.journal.code}]' if task.journal else '' + params_label = ( + ', '.join(f'{k}={v}' for k, v in task.parameters.items()) + if task.parameters else 'no parameters' + ) + self.stdout.write( + f' [{task.pk}] {task.report_name}{journal_label} ' + f'requested by {task.user.email} ' + f'at {task.created.strftime("%Y-%m-%d %H:%M")} ' + f'({params_label}) [attempt {task.attempt_count + 1}/{self.MAX_ATTEMPTS}]', + ) + execute_report(task.pk) + task.refresh_from_db() + if task.status == ReportTask.STATUS_COMPLETE: + self.stdout.write( + self.style.SUCCESS(f' -> complete: {task.file_path}'), + ) + else: + self.stdout.write( + self.style.ERROR( + f' -> failed (attempt {task.attempt_count}/' + f'{self.MAX_ATTEMPTS}): {task.error_message}' + ), + ) + if task.attempt_count < self.MAX_ATTEMPTS: + task.status = ReportTask.STATUS_PENDING + task.save(update_fields=['status']) + + self.stdout.write( + self.style.SUCCESS(f'Done. Processed {count} report task(s).'), + ) diff --git a/migrations/0001_initial.py b/migrations/0001_initial.py new file mode 100644 index 0000000..a18e836 --- /dev/null +++ b/migrations/0001_initial.py @@ -0,0 +1,73 @@ +from django.conf import settings +from django.db import migrations, models +import django.db.models.deletion +import django.utils.timezone + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + migrations.swappable_dependency(settings.AUTH_USER_MODEL), + ('journal', '0001_initial'), + ] + + operations = [ + migrations.CreateModel( + name='ReportTask', + fields=[ + ('id', models.AutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name='ID', + )), + ('report_type', models.CharField(max_length=50)), + ('report_name', models.CharField(max_length=255)), + ('parameters', models.JSONField(blank=True, default=dict)), + ('status', models.CharField( + choices=[ + ('pending', 'Pending'), + ('processing', 'Processing'), + ('complete', 'Complete'), + ('failed', 'Failed'), + ], + default='pending', + max_length=20, + )), + ('created', models.DateTimeField( + default=django.utils.timezone.now, + )), + ('completed', models.DateTimeField( + blank=True, null=True, + )), + ('file_path', models.CharField( + blank=True, default='', max_length=500, + )), + ('error_message', models.TextField( + blank=True, default='', + )), + ('site_url', models.CharField( + blank=True, + default='', + help_text='Base site URL captured at request time for email links.', + max_length=500, + )), + ('journal', models.ForeignKey( + blank=True, + null=True, + on_delete=django.db.models.deletion.CASCADE, + to='journal.journal', + )), + ('user', models.ForeignKey( + on_delete=django.db.models.deletion.CASCADE, + related_name='report_tasks', + to=settings.AUTH_USER_MODEL, + )), + ], + options={ + 'ordering': ['-created'], + }, + ), + ] diff --git a/migrations/0002_reporttask_attempt_count.py b/migrations/0002_reporttask_attempt_count.py new file mode 100644 index 0000000..6dcfcc6 --- /dev/null +++ b/migrations/0002_reporttask_attempt_count.py @@ -0,0 +1,16 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('deferred_reports', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='reporttask', + name='attempt_count', + field=models.PositiveSmallIntegerField(default=0), + ), + ] diff --git a/migrations/__init__.py b/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/models.py b/models.py new file mode 100644 index 0000000..ce2a4a2 --- /dev/null +++ b/models.py @@ -0,0 +1,62 @@ +from django.db import models +from django.utils import timezone + + +class ReportTask(models.Model): + STATUS_PENDING = 'pending' + STATUS_PROCESSING = 'processing' + STATUS_COMPLETE = 'complete' + STATUS_FAILED = 'failed' + + STATUS_CHOICES = ( + (STATUS_PENDING, 'Pending'), + (STATUS_PROCESSING, 'Processing'), + (STATUS_COMPLETE, 'Complete'), + (STATUS_FAILED, 'Failed'), + ) + + user = models.ForeignKey( + 'core.Account', + on_delete=models.CASCADE, + related_name='report_tasks', + ) + journal = models.ForeignKey( + 'journal.Journal', + on_delete=models.CASCADE, + null=True, + blank=True, + ) + report_type = models.CharField(max_length=50) + report_name = models.CharField(max_length=255) + parameters = models.JSONField(default=dict, blank=True) + status = models.CharField( + max_length=20, + choices=STATUS_CHOICES, + default=STATUS_PENDING, + ) + attempt_count = models.PositiveSmallIntegerField(default=0) + created = models.DateTimeField(default=timezone.now) + completed = models.DateTimeField(null=True, blank=True) + file_path = models.CharField(max_length=500, blank=True, default='') + error_message = models.TextField(blank=True, default='') + site_url = models.CharField( + max_length=500, + blank=True, + default='', + help_text='Base site URL captured at request time for email links.', + ) + + class Meta: + ordering = ['-created'] + + def __str__(self): + return f'{self.report_name} ({self.status})' + + @property + def is_downloadable(self): + import os + return ( + self.status == self.STATUS_COMPLETE + and self.file_path + and os.path.exists(self.file_path) + ) diff --git a/plugin_settings.py b/plugin_settings.py new file mode 100644 index 0000000..b06ad51 --- /dev/null +++ b/plugin_settings.py @@ -0,0 +1,376 @@ +from utils import plugins + +# --------------------------------------------------------------------------- +# Permission level constants +# --------------------------------------------------------------------------- + +PERM_EDITOR = 'editor' +PERM_STAFF = 'staff' +PERM_REPOSITORY_MANAGER = 'repository_manager' + +# --------------------------------------------------------------------------- +# Report type registry +# --------------------------------------------------------------------------- + +REPORT_TYPES = { + 'press': { + 'name': 'Press Report', + 'description': ( + 'One row per non-remote journal. The date range filters ' + 'submissions (by submitted date), publications (by published ' + 'date), rejections (by declined date), and views and downloads ' + '(by access date). User counts are a current snapshot and are ' + 'not date-filtered.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'articles': { + 'name': 'Article Metrics', + 'description': ( + 'One row per published article in the journal, covering all ' + 'currently published articles regardless of date. ' + 'The date range filters the access metrics (views and downloads) ' + 'only; it does not affect which articles are included.' + ), + 'form': 'JournalDateReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + }, + 'usage_by_month': { + 'name': 'Journal Usage by Month', + 'description': ( + 'Pivoted table with one row per journal and one column per ' + 'calendar month. The month range determines both which months ' + 'appear as columns and which access events are counted. ' + 'Abstract-only page views (no galley) are excluded. ' + 'Hidden and remote journals are excluded.' + ), + 'form': 'MonthRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'production': { + 'name': 'Production Times', + 'description': ( + 'One row per typesetting task. The date range filters on the ' + 'assignment date. Only tasks where both the accepted and ' + 'completed dates are recorded are included.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'geo': { + 'name': 'Geographical Spread', + 'description': ( + 'Access events (views and downloads) to published articles ' + 'grouped by country. The date range filters the access events. ' + 'Can be scoped to a single journal or run press-wide.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'review': { + 'name': 'Peer Review', + 'description': ( + 'One row per completed review assignment. The date range filters ' + 'on the date the review was requested. Only assignments where ' + 'both the acceptance and completion dates are recorded are ' + 'included. Can be scoped to a single journal or run press-wide.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'citations': { + 'name': 'Article Citations', + 'description': ( + 'Citation counts from Crossref data. The year parameter filters ' + 'which citation records are counted by the year of the citing ' + 'work; select all-time to include citations from every year. ' + 'Only articles with at least one recorded citation are included. ' + 'Can be scoped to a single journal or run press-wide.' + ), + 'form': 'YearReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'journal_citations': { + 'name': 'Journal Citations', + 'description': ( + 'All-time Crossref citation totals per journal. No date ' + 'filtering; covers all citation records regardless of year. ' + 'One row per visible journal.' + ), + 'form': 'ReportRequestForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'authors': { + 'name': 'Article Authors', + 'description': ( + 'One row per author per published article. The date range ' + 'filters which authors are included: only those with at least ' + 'one article published within the range. All published articles ' + 'for each matched author are then listed, not just those within ' + 'the range. Can be scoped to a single journal or run press-wide.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'reviewers': { + 'name': 'Peer Reviewers Data', + 'description': ( + 'Lifetime review statistics per reviewer for the selected ' + 'journal. No date filtering; covers all assignments on record. ' + 'Only reviewers with at least one assignment in the journal ' + 'are included.' + ), + 'form': 'JournalOnlyReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + }, + 'author_data': { + 'name': 'Author Submission Data', + 'description': ( + 'Submission statistics per author for the selected journal. ' + 'No date filtering; covers all submissions on record. ' + 'Only accounts with the Author role in the journal are included.' + ), + 'form': 'JournalOnlyReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + }, + 'workflow': { + 'name': 'Workflow Report', + 'description': ( + 'Lead-time analysis: submission-to-acceptance, ' + 'acceptance-to-publication, and submission-to-publication. ' + 'The month range filters on publication date; only articles ' + 'published within the selected months are included. ' + 'Opens with summary averages followed by a per-article ' + 'breakdown. Can be scoped to a single journal or run ' + 'press-wide.' + ), + 'form': 'MonthRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'workflow_stages': { + 'name': 'Workflow Stage Completion', + 'description': ( + 'Time spent in each workflow stage per article. The month range ' + 'filters on submission date; only articles submitted within ' + 'the selected months that have since been published are ' + 'included. Stage columns are dynamic, based on the workflow ' + 'elements configured for the journal.' + ), + 'form': 'MonthRangeReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + }, + 'yearly_stats': { + 'name': 'Yearly Statistics', + 'description': ( + 'Year-by-year submission funnel for the selected journal. ' + 'No date parameters; automatically covers all years from the ' + 'earliest submission on record to the current year. Each ' + 'year\'s counts are based on submission date.' + ), + 'form': 'JournalOnlyReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'under_review': { + 'name': 'Articles Under Review', + 'description': ( + 'Live snapshot of all open review assignments for articles ' + 'currently in the Under Review stage. No date filtering; ' + 'reflects the current state of the journal at the time of ' + 'the request.' + ), + 'form': 'JournalOnlyReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'first_decision': { + 'name': 'Time to First Decision', + 'description': ( + 'First editorial decision (accept, decline, or revision request) ' + 'for each article. The date range filters on submission date; ' + 'only articles submitted within the range are included.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + }, + 'journal_citations_detail': { + 'name': 'Journal Article Citations', + 'description': ( + 'All-time Crossref citation counts for articles in the selected ' + 'journal. No date filtering; covers all citation records ' + 'regardless of year. Only articles with at least one recorded ' + 'citation are included.' + ), + 'form': 'JournalOnlyReportForm', + 'needs_journal': True, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'article_citing_works': { + 'name': 'Article Citing Works', + 'description': ( + 'All works recorded in Crossref data as citing a specific ' + 'article. No date filtering; covers all citation records ' + 'on file. Select a journal then pick an article from the list.' + ), + 'form': 'ArticleJournalSelectForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'book_citations': { + 'name': 'Book Citations', + 'description': ( + 'All-time citation counts per published book from Crossref ' + 'BookLink data, matched by DOI. No date filtering. ' + 'Requires the Books plugin.' + ), + 'form': 'ReportRequestForm', + 'needs_journal': False, + 'permission': PERM_STAFF, + 'instant': True, + }, + 'book_citing_works': { + 'name': 'Book Citing Works', + 'description': ( + 'All works recorded in Crossref BookLink data as citing a ' + 'specific book, matched by DOI. No date filtering. ' + 'Select a book from the list. Requires the Books plugin.' + ), + 'form': 'BookCitingWorksForm', + 'needs_journal': False, + 'permission': PERM_STAFF, + 'instant': True, + }, + 'crossref_dois': { + 'name': 'Crossref DOI URLs', + 'description': ( + 'Tab-separated file mapping every registered DOI to its article ' + 'URL. No date filtering; covers all published articles with a ' + 'registered DOI. Includes supplementary file DOIs where ' + 'available. Can be scoped to a single journal or exported ' + 'press-wide.' + ), + 'form': 'OptionalJournalReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'crossref_dois_crosscheck': { + 'name': 'Crossref CrossCheck URLs', + 'description': ( + 'Tab-separated file mapping every registered DOI to the direct ' + 'URL of its full-text PDF galley, for submission to Crossref ' + 'CrossCheck (iThenticate). No date filtering; covers all ' + 'published articles with a registered DOI and a PDF galley. ' + 'Can be scoped to a single journal or exported press-wide.' + ), + 'form': 'OptionalJournalReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + 'instant': True, + }, + 'licenses': { + 'name': 'License Report', + 'description': ( + 'Article counts grouped by licence and journal. The date range ' + 'filters on publication date; only articles published within ' + 'the range are counted.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_EDITOR, + }, + 'preprints_metrics': { + 'name': 'Preprints Metrics', + 'description': ( + 'Views and downloads per preprint. The date range filters the ' + 'access events; only preprints with at least one access in ' + 'the range appear in the report. Views are page-level accesses ' + '(no file); downloads are file-level accesses. ' + 'Requires the repository to be active.' + ), + 'form': 'DateRangeReportForm', + 'needs_journal': False, + 'permission': PERM_REPOSITORY_MANAGER, + }, +} + +# --------------------------------------------------------------------------- +# Parameter display labels (used when rendering report parameters in the UI) +# --------------------------------------------------------------------------- + +PARAMETER_LABELS = { + 'start_date': 'From', + 'end_date': 'To', + 'start_month': 'From', + 'end_month': 'To', + 'year': 'Year', + 'all_time': 'All time', + 'article_id': 'Article ID', + 'book_id': 'Book ID', +} + +# --------------------------------------------------------------------------- +# File storage +# --------------------------------------------------------------------------- + +import os +from django.conf import settings + +REPORTS_DIR = os.path.join(settings.BASE_DIR, 'files', 'deferred_reports') + +# --------------------------------------------------------------------------- +# Plugin metadata +# --------------------------------------------------------------------------- + +PLUGIN_NAME = 'deferred_reports' +DESCRIPTION = ( + 'Generates reports as background tasks and notifies users by email ' + 'when their CSV download is ready.' +) +AUTHOR = 'Andy Byers' +VERSION = '1.0' +SHORT_NAME = 'deferred_reports' +DISPLAY_NAME = 'Deferred Reports' +MANAGER_URL = 'deferred_reports_index' +JANEWAY_VERSION = "1.5.1" + + +class ReportingAsyncPlugin(plugins.Plugin): + plugin_name = PLUGIN_NAME + display_name = DISPLAY_NAME + description = DESCRIPTION + author = AUTHOR + short_name = SHORT_NAME + version = VERSION + janeway_version = JANEWAY_VERSION + manager_url = MANAGER_URL + + +def install(): + from utils.install import update_settings + ReportingAsyncPlugin.install() + update_settings(file_path='plugins/deferred_reports/install/settings.json') + + +def hook_registry(): + return {} diff --git a/templates/deferred_reports/configure_article_citing_works.html b/templates/deferred_reports/configure_article_citing_works.html new file mode 100644 index 0000000..6426fa9 --- /dev/null +++ b/templates/deferred_reports/configure_article_citing_works.html @@ -0,0 +1,114 @@ +{% extends "admin/core/base.html" %} + +{% block title %}Configure Report: {{ info.name }}{% endblock %} +{% block title-section %}{{ info.name }}{% endblock %} +{% block title-sub %}{{ info.description }}{% endblock %} + +{% block breadcrumbs %} + {{ block.super }} +Select an article from {{ journal.name }}.
+ + {% if articles %} + + {% else %} +No articles found for {{ journal.name }}.
+No published books found.
+View and download your generated reports.
+ {% if tasks %} +| Report | +Status | +Requested | +Completed | +Actions | +
|---|---|---|---|---|
|
+ {{ task.report_name }}
+ {% if task.journal %}
+ {{ task.journal.name }} + {% endif %} + {% if task.parameters %} + + {% for key, value in task.parameters.items %} + {% if key != 'journal_id' %} + {{ key }}: {{ value }} + {% endif %} + {% endfor %} + {% endif %} + |
+ + {% if task.status == 'pending' %} + Pending + {% elif task.status == 'processing' %} + Processing + {% elif task.status == 'complete' %} + Complete + {% elif task.status == 'failed' %} + Failed + {% endif %} + | +{{ task.created|date:"Y-m-d H:i" }} | ++ {% if task.completed %} + {{ task.completed|date:"Y-m-d H:i" }} + {% else %} + - + {% endif %} + | ++ {% if task.is_downloadable %} + + View + + + Download CSV + + {% endif %} + {% if task.status == 'failed' %} + + Error: {{ task.error_message|truncatewords:10 }} + + {% endif %} + {% if task.status == 'pending' or task.status == 'processing' %} + In progress... + {% endif %} + + Delete + + | +
You have not requested any reports yet. + Request one now.
+ {% endif %} ++ Requested {{ task.created|date:"Y-m-d H:i" }} + {% if task.journal %} — {{ task.journal.name }}{% endif %} +
+ {% if display_parameters %} ++ {% for label, value in display_parameters %} + {% if not forloop.first %} — {% endif %} + {{ label }}: {{ value }} + {% endfor %} +
+ {% endif %} + +