Merge pull request #1542 from xibosignage/develop

Release 3.3.2
xibosignage · Jan 10, 2023 · c073160 · c073160
2 parents 2ccc30f + a97db08
commit c073160
Show file tree

Hide file tree

Showing 128 changed files with 5,879 additions and 623 deletions.
diff --git a/.github/workflows/build-container.yaml b/.github/workflows/build-container.yaml
@@ -12,7 +12,7 @@ jobs:
   build:
     name: Build Containers
     if: github.repository == 'xibosignage/xibo-cms'
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v1

diff --git a/.github/workflows/build-cypress.yaml b/.github/workflows/build-cypress.yaml
@@ -9,7 +9,7 @@ on:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v1

diff --git a/.github/workflows/build-tag.yaml b/.github/workflows/build-tag.yaml
@@ -9,7 +9,7 @@ jobs:
   build:
     name: Build Containers
     if: github.repository == 'xibosignage/xibo-cms'
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v1

diff --git a/.github/workflows/test-suite.yaml b/.github/workflows/test-suite.yaml
@@ -8,7 +8,7 @@ on:
 jobs:
   test-suite:
     name: Build Containers and Run Tests
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v1

diff --git a/README.md b/README.md
@@ -1,14 +1,13 @@
 # Introduction
 Xibo - Digital Signage - https://xibo.org.uk
-Copyright (C) 2006-2022 Xibo Signage Ltd and Contributors.
+Copyright (C) 2006-2023 Xibo Signage Ltd and Contributors.
 
 
 
 #### Branches
 
 - develop: Work in progress toward 4.0
-- master: Currently 3.2
-- release33: Release preparation for 3.3.x
+- master: Currently 3.3
 - release32: Bug fixes for 3.2
 - release31: Bug fixes for 3.1
 - release30: Bug fixes 3.0

diff --git a/lib/Connector/XiboAudienceReportingConnector.php b/lib/Connector/XiboAudienceReportingConnector.php
diff --git a/lib/Connector/XiboSspConnector.php b/lib/Connector/XiboSspConnector.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (C) 2022 Xibo Signage Ltd
+ * Copyright (C) 2023 Xibo Signage Ltd
  *
  * Xibo - Digital Signage - http://www.xibo.org.uk
  *
@@ -429,7 +429,7 @@ public function activity(SanitizerInterface $params): array
                 'headers' => [
                     'X-API-KEY' => $this->getSetting('apiKey'),
                 ],
-                'json' => [
+                'query' => [
                     'cmsUrl' => $this->getSetting('cmsUrl'),
                     'fromDt' => $fromDt->toAtomString(),
                     'toDt' => $toDt->toAtomString(),

diff --git a/lib/Controller/Campaign.php b/lib/Controller/Campaign.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (C) 2022 Xibo Signage Ltd
+ * Copyright (C) 2023 Xibo Signage Ltd
  *
  * Xibo - Digital Signage - http://www.xibo.org.uk
  *
@@ -1313,7 +1313,7 @@ public function copy(Request $request, Response $response, $id)
         $newCampaign->campaign = $sanitizedParams->getString('name');
 
         // assign the same layouts to the new Campaign
-        foreach ($campaign->layouts as $layout) {
+        foreach ($campaign->loadLayouts() as $layout) {
             $newCampaign->assignLayout(
                 $layout->layoutId,
                 $layout->displayOrder,
@@ -1323,6 +1323,12 @@ public function copy(Request $request, Response $response, $id)
             );
         }
 
+        // is the original campaign an ad campaign?
+        if ($campaign->type === 'ad') {
+            // assign the same displays to the new Campaign
+            $newCampaign->replaceDisplayGroupIds($campaign->loadDisplayGroupIds());
+        }
+
         $newCampaign->save();
 
         // Return
@@ -1446,7 +1452,12 @@ public function selectFolder(Request $request, Response $response, $id)
         }
 
         // Save
-        $campaign->save();
+        $campaign->save([
+            'validate' => false,
+            'notify' => false,
+            'collectNow' => false,
+            'saveTags' => false
+        ]);
 
         // Return
         $this->getState()->hydrate([

diff --git a/lib/Controller/DataSetColumn.php b/lib/Controller/DataSetColumn.php
@@ -369,6 +369,11 @@ public function add(Request $request, Response $response, $id)
         // Assign the column to set the column order if necessary
         $dataSet->assignColumn($column);
 
+        // client side formula disable sort
+        if (substr($column->formula, 0, 1) === '$') {
+            $column->showSort = 0;
+        }
+
         // Save the column
         $column->save();
 
@@ -569,6 +574,12 @@ public function edit(Request $request, Response $response, $id, $colId)
         $column->tooltip = $sanitizedParams->getString('tooltip');
         $column->isRequired = $sanitizedParams->getCheckbox('isRequired');
         $column->dateFormat = $sanitizedParams->getString('dateFormat', ['default' => null]);
+
+        // client side formula disable sort
+        if (substr($column->formula, 0, 1) === '$') {
+            $column->showSort = 0;
+        }
+
         $column->save();
 
         if ($column->dataSetColumnTypeId == 3 && $column->hasPropertyChanged('remoteField')) {

diff --git a/lib/Controller/DataSetData.php b/lib/Controller/DataSetData.php
@@ -1,6 +1,6 @@
 <?php
-/**
- * Copyright (C) 2021 Xibo Signage Ltd
+/*
+ * Copyright (C) 2023 Xibo Signage Ltd
  *
  * Xibo - Digital Signage - http://www.xibo.org.uk
  *
@@ -258,21 +258,19 @@ public function add(Request $request, Response $response, $id)
         foreach ($dataSet->getColumn() as $column) {
             /* @var \Xibo\Entity\DataSetColumn $column */
             if ($column->dataSetColumnTypeId == 1) {
-
                 // Sanitize accordingly
                 if ($column->dataTypeId == 2) {
                     // Number
                     $value = $sanitizedParams->getDouble('dataSetColumnId_' . $column->dataSetColumnId);
-                }
-                else if ($column->dataTypeId == 3) {
+                } else if ($column->dataTypeId == 3) {
                     // Date
-                    $value = $sanitizedParams->getDate('dataSetColumnId_' . $column->dataSetColumnId)->format(DateFormatHelper::getSystemFormat());
-                }
-                else if ($column->dataTypeId == 5) {
+                    $date = $sanitizedParams->getDate('dataSetColumnId_' . $column->dataSetColumnId);
+                    // format only if we have the date provided.
+                    $value = $date === null ? $date : $date->format(DateFormatHelper::getSystemFormat());
+                } else if ($column->dataTypeId == 5) {
                     // Media Id
                     $value = $sanitizedParams->getInt('dataSetColumnId_' . $column->dataSetColumnId);
-                }
-                else {
+                } else {
                     // String
                     $value = $sanitizedParams->getString('dataSetColumnId_' . $column->dataSetColumnId);
                 }

diff --git a/lib/Controller/Display.php b/lib/Controller/Display.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (C) 2022 Xibo Signage Ltd
+ * Copyright (C) 2023 Xibo Signage Ltd
  *
  * Xibo - Digital Signage - http://www.xibo.org.uk
  *
@@ -1486,7 +1486,7 @@ function deleteForm(Request $request, Response $response, $id)
      *      name="costPerPlay",
      *      in="formData",
      *      description="The Cost Per Play of this Display",
-     *      type="double",
+     *      type="number",
      *      required=false
      *   ),
      *  @SWG\Parameter(

diff --git a/lib/Controller/Layout.php b/lib/Controller/Layout.php
@@ -3013,7 +3013,8 @@ public function addThumbnail(Request $request, Response $response, $id): Respons
             foreach ($layout->regions as $region) {
                 try {
                     // Get widgets in this region
-                    $widgets = $region->regionPlaylist->expandWidgets();
+                    $playlist = $region->getPlaylist()->setModuleFactory($this->moduleFactory);
+                    $widgets = $playlist->expandWidgets();
 
                     if (count($widgets) <= 0) {
                         // Render the region (draw a grey box)

diff --git a/lib/Controller/Schedule.php b/lib/Controller/Schedule.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (C) 2022 Xibo Signage Ltd
+ * Copyright (C) 2023 Xibo Signage Ltd
  *
  * Xibo - Digital Signage - http://www.xibo.org.uk
  *
@@ -282,7 +282,13 @@ public function eventData(Request $request, Response $response)
         ];
 
         if ($campaignId != null) {
-            $filter['campaignId'] = $campaignId;
+            // Is this an ad campaign?
+            $campaign = $this->campaignFactory->getById($campaignId);
+            if ($campaign->type === 'ad') {
+                $filter['parentCampaignId'] = $campaignId;
+            } else {
+                $filter['campaignId'] = $campaignId;
+            }
         }
 
         foreach ($this->scheduleFactory->query('FromDT', $filter) as $row) {
@@ -324,7 +330,7 @@ public function eventData(Request $request, Response $response)
                 $title = __('%s scheduled on %s', $row->command, $displayGroupList);
             } else {
                 // Should we show the Layout name, or not (depending on permission)
-                // Make sure we only run the below code if we have to, its quite expensive
+                // Make sure we only run the below code if we have to, it's quite expensive
                 if (!$showLayoutName && !$this->getUser()->isSuperAdmin()) {
                     // Campaign
                     $campaign = $this->campaignFactory->getById($row->campaignId);
@@ -333,7 +339,12 @@ public function eventData(Request $request, Response $response)
                         $row->campaign = __('Private Item');
                     }
                 }
-                $title = __('%s scheduled on %s', $row->campaign, $displayGroupList);
+
+                $title = sprintf(
+                    __('%s scheduled on %s'),
+                    $row->getUnmatchedProperty('parentCampaignName', $row->campaign),
+                    $displayGroupList
+                );
 
                 if ($row->eventTypeId === \Xibo\Entity\Schedule::$INTERRUPT_EVENT) {
                     $title .= __(' with Share of Voice %d seconds per hour', $row->shareOfVoice);
@@ -989,6 +1000,15 @@ public function add(Request $request, Response $response)
         // Set the parentCampaignId for campaign events
         if ($schedule->eventTypeId === \Xibo\Entity\Schedule::$CAMPAIGN_EVENT) {
             $schedule->parentCampaignId = $schedule->campaignId;
+
+            // Make sure we're not directly scheduling an ad campaign
+            $campaign = $this->campaignFactory->getById($schedule->campaignId);
+            if ($campaign->type === 'ad') {
+                throw new InvalidArgumentException(
+                    __('Direct scheduling of an Ad Campaign is not allowed'),
+                    'campaignId'
+                );
+            }
         }
 
         // Fields only collected for interrupt events
@@ -1550,6 +1570,15 @@ public function edit(Request $request, Response $response, $id)
         // Set the parentCampaignId for campaign events
         if ($schedule->eventTypeId === \Xibo\Entity\Schedule::$CAMPAIGN_EVENT) {
             $schedule->parentCampaignId = $schedule->campaignId;
+
+            // Make sure we're not directly scheduling an ad campaign
+            $campaign = $this->campaignFactory->getById($schedule->campaignId);
+            if ($campaign->type === 'ad') {
+                throw new InvalidArgumentException(
+                    __('Direct scheduling of an Ad Campaign is not allowed'),
+                    'campaignId'
+                );
+            }
         }
 
         // Fields only collected for interrupt events

diff --git a/lib/Controller/Stats.php b/lib/Controller/Stats.php
@@ -24,6 +24,7 @@
 use Carbon\Carbon;
 use Slim\Http\Response as Response;
 use Slim\Http\ServerRequest as Request;
+use Xibo\Event\ConnectorReportEvent;
 use Xibo\Factory\DisplayFactory;
 use Xibo\Factory\DisplayGroupFactory;
 use Xibo\Factory\LayoutFactory;
@@ -90,13 +91,19 @@ public function __construct($store, $timeSeriesStore, $reportService, $displayFa
      */
     function displayReportPage(Request $request, Response $response)
     {
+        // ------------
+        // Dispatch an event to get connector reports
+        $event = new ConnectorReportEvent();
+        $this->getDispatcher()->dispatch($event, ConnectorReportEvent::$NAME);
+
         $data = [
             // List of Displays this user has permission for
             'defaults' => [
                 'fromDate' => Carbon::now()->subSeconds(86400 * 35)->format(DateFormatHelper::getSystemFormat()),
                 'fromDateOneDay' => Carbon::now()->subSeconds(86400)->format(DateFormatHelper::getSystemFormat()),
                 'toDate' => Carbon::now()->format(DateFormatHelper::getSystemFormat()),
-                'availableReports' => $this->reportService->listReports()
+                'availableReports' => $this->reportService->listReports(),
+                'connectorReports' => $event->getReports()
             ]
         ];
 

diff --git a/lib/Entity/Campaign.php b/lib/Entity/Campaign.php
@@ -1086,4 +1086,26 @@ public function saveIncrementPlays(): Campaign
         ]);
         return $this;
     }
+
+    /**
+     * Overwrite the number of plays/spend and impressions
+     * @return $this
+     */
+    public function overwritePlays(): Campaign
+    {
+
+        $this->getStore()->update('
+            UPDATE `campaign`
+                SET `plays` = :plays,
+                    `spend` = :spend,
+                    `impressions` = :impressions
+             WHERE campaignId = :campaignId
+        ', [
+            'plays' => $this->plays,
+            'spend' => $this->spend,
+            'impressions' => $this->impressions,
+            'campaignId' => $this->campaignId,
+        ]);
+        return $this;
+    }
 }