Merge pull request #1 from trendyminds/1.2.0

1.2.0

Author: aaronbushnell

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release Notes for Reporter
 
+## 1.2.0 - 2022-03-01
+
+> {warning} This update modifies the permission behavior of the plugin. If you have given permissions to users or user groups for Reporter you will need to re-enable these under the "General" section of Craft's permission utility for each user/group.
+
+### Added
+- Process reports via the CLI using `php craft reporter/report --handle=myReport`
+
+### Updated
+- Use `$hasCpSection` to insert Reporter navigation link in the control panel. This ensures it's ordered properly in the sidebar by Craft.
+- Use Craft's baked-in permissions when using `$hasCpSection` instead of custom one.
+
 ## 1.1.0 - 2022-02-17
 
 ### Updated

README.md

@@ -9,6 +9,7 @@
 - 🏎 Reports are processed with [Query Batching](https://www.yiiframework.com/doc/api/2.0/yii-db-query#batch()-detail), making exports run quickly and without exhausting your memory limit
 - 🧘 Inspired by [Element API](https://github.com/craftcms/element-api), create reports with a simple and familiar structure
 - 📦 Reports stored using Asset volumes so you can host reports locally or on a cloud-based service like Amazon S3
+- 🖥 Process reports via the CLI using `php craft reporter/report --handle=myReport` where `myReport` is the key of a specific report in the `reports` array found in `config/reporter.php`.
 
 ## 📦 Installing
 

composer.json

@@ -2,7 +2,7 @@
   "name": "trendyminds/craft-reporter",
   "description": "Export Craft data as CSVs in a snap",
   "type": "craft-plugin",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "keywords": ["reports", "craft", "craft cms"],
   "license": "MIT",
   "authors": [

src/Reporter.php

@@ -4,18 +4,16 @@
 
 use Craft;
 use craft\base\Plugin;
-use craft\events\RegisterCpNavItemsEvent;
-use craft\web\twig\variables\Cp;
 use craft\events\RegisterUrlRulesEvent;
-use craft\events\RegisterUserPermissionsEvent;
 use craft\models\VolumeFolder;
-use craft\services\UserPermissions;
 use craft\web\UrlManager;
 use Stringy\Stringy;
 use yii\base\Event;
 
 class Reporter extends Plugin
 {
+	public $hasCpSection = true;
+
 	public function init()
 	{
 		parent::init();
@@ -29,35 +27,6 @@ function (RegisterUrlRulesEvent $event) {
 				$event->rules['reporter/exports'] = 'reporter/default/exports';
 			}
 		);
-
-		// Setup the control panel navigation link
-		Event::on(
-			Cp::class,
-			Cp::EVENT_REGISTER_CP_NAV_ITEMS,
-			function(RegisterCpNavItemsEvent $event) {
-				// Add the navigation item if the user has access to Reporter
-				if (Craft::$app->user->checkPermission('accessReporter')) {
-					$event->navItems[] = [
-						'url' => 'reporter',
-						'label' => $this->getSettings()->displayName,
-						'icon' => '@trendyminds/reporter/icon-mask.svg'
-					];
-				}
-			}
-		);
-
-		// Setup user permissions to access the plugin area
-		Event::on(
-			UserPermissions::class,
-			UserPermissions::EVENT_REGISTER_PERMISSIONS,
-			function(RegisterUserPermissionsEvent $event) {
-				$event->permissions['Reporter'] = [
-					'accessReporter' => [
-						'label' => 'Access Reporter',
-					],
-				];
-			}
-		);
 	}
 
 	/**
@@ -80,7 +49,7 @@ public function getReport(string $name)
 	public function getExportPath()
 	{
 		$volume = Craft::$app->getVolumes()->getVolumeByHandle(
-			$this->getSettings()->volume
+			$this->getSettings()->volume ?? ''
 		);
 
 		if (!$volume) {

src/console/controllers/ReportController.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace trendyminds\reporter\console\controllers;
+
+Use Craft;
+use craft\console\Controller;
+use trendyminds\reporter\jobs\ExportJob;
+use trendyminds\reporter\Reporter;
+use yii\helpers\Console;
+
+class ReportController extends Controller
+{
+	/**
+	 * @var string The handle of the report to export
+	 */
+	public $handle = null;
+
+	public function options($actionID)
+	{
+		$options = parent::options($actionID);
+		$options[] = 'handle';
+
+		return $options;
+	}
+
+	/**
+	 *  Export a single Reporter report using --handle=myReportHandle
+	 */
+	public function actionIndex()
+	{
+		// Error if the user did not supply a --handle param
+		if (! $this->handle) {
+			$this->stderr("You must supply a --handle parameter to indicate which report to process:" . PHP_EOL, Console::FG_RED);
+			$this->stderr("php craft reporter/report --handle=myReportHandle" . PHP_EOL);
+			die();
+		}
+
+		// Get the report by its handle
+		$report = Reporter::getInstance()->getReport($this->handle);
+
+		// Error out if we did not find a match
+		if(! $report) {
+			$this->stderr("You must specify the handle of an existing report to export." . PHP_EOL, Console::FG_RED);
+			$this->stderr("Consult `config/reporter.php` to ensure you created at least one report and properly referenced the handle." . PHP_EOL, Console::FG_RED);
+			die();
+		}
+
+		// Process the closure and reassign the output for the remaining steps
+		$report = $report();
+
+		// Provide a bit of visual feedback to the user that their report is being processed
+		$this->stdout('Added an export of the "' . $report['name'] . '" report to the queue.' . PHP_EOL, Console::FG_BLUE);
+
+		// Send the process to the queue
+		Craft::$app->getQueue()->push(
+			new ExportJob([
+				'handle' => $this->handle,
+				'name' => $report['name'],
+			])
+		);
+	}
+}

src/controllers/DefaultController.php

@@ -17,7 +17,7 @@ class DefaultController extends Controller
 	 */
 	public function actionIndex()
 	{
-		$this->requirePermission('accessReporter');
+		$this->requirePermission('accessPlugin-reporter');
 
 		return $this->renderTemplate("reporter/index", [
 			'displayName' => Reporter::getInstance()->getSettings()->displayName,
@@ -39,7 +39,7 @@ public function actionIndex()
 	 */
 	public function actionExports()
 	{
-		$this->requirePermission('accessReporter');
+		$this->requirePermission('accessPlugin-reporter');
 
 		$folderVolume = Reporter::getInstance()->getExportPath();
 
@@ -53,7 +53,7 @@ public function actionExports()
 	 */
 	public function actionRun()
 	{
-		$this->requirePermission('accessReporter');
+		$this->requirePermission('accessPlugin-reporter');
 		$this->requirePostRequest();
 
 		$reportHandle = $this->request->getRequiredBodyParam('report');