vendor/elements/process-manager-bundle/src/Controller/MonitoringItemController.php line 187

Open in your IDE?
  1. <?php
  3. /**
  4.  * Elements.at
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Enterprise License (PEL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) elements.at New Media Solutions GmbH (https://www.elements.at)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PEL
  14.  */
  16. namespace Elements\Bundle\ProcessManagerBundle\Controller;
  18. use Elements\Bundle\ProcessManagerBundle\Executor\Action\AbstractAction;
  19. use Elements\Bundle\ProcessManagerBundle\Executor\Logger\AbstractLogger;
  20. use Elements\Bundle\ProcessManagerBundle\Executor\Logger\Application;
  21. use Elements\Bundle\ProcessManagerBundle\Executor\Logger\File;
  22. use Elements\Bundle\ProcessManagerBundle\Model\Configuration;
  23. use Elements\Bundle\ProcessManagerBundle\Model\MonitoringItem;
  24. use Pimcore\Bundle\AdminBundle\Controller\AdminController;
  25. use Pimcore\Bundle\AdminBundle\Helper\QueryParams;
  26. use Pimcore\Templating\Model\ViewModel;
  27. use Symfony\Component\HttpFoundation\JsonResponse;
  28. use Symfony\Component\HttpFoundation\Request;
  29. use Symfony\Component\HttpKernel\Profiler\Profiler;
  30. use Symfony\Component\Routing\Annotation\Route;
  31. use Elements\Bundle\ProcessManagerBundle\ElementsProcessManagerBundle;
  32. use Elements\Bundle\ProcessManagerBundle\Enums;
  33. /**
  34.  * @Route("/admin/elementsprocessmanager/monitoring-item")
  35.  */
  36. class MonitoringItemController extends AdminController
  37. {
  38.     /**
  39.      * @Route("/list")
  40.      *
  41.      * @param Request $request
  42.      *
  43.      * @return JsonResponse
  44.      */
  45.     public function listAction(Request $request)
  46.     {
  47.         $this->checkPermission(Enums\Permissions::VIEW);
  48.         $data = [];
  49.         $list = new MonitoringItem\Listing();
  50.         $list->setOrder('DESC');
  51.         $list->setOrderKey('id');
  52.         $list->setLimit($request->get('limit', 25));
  53.         $list->setUser($this->getAdminUser());
  55.         $list->setOffset($request->get('start'));
  57.         $allParams = array_merge($request->request->all(), $request->query->all());
  58.         $sortingSettings = QueryParams::extractSortingSettings($allParams);
  59.         if ($sortingSettings['orderKey'] && $sortingSettings['order']) {
  60.             $list->setOrderKey($sortingSettings['orderKey']);
  61.             $list->setOrder($sortingSettings['order']);
  62.         }
  64.         $callbacks = [
  65.             'executedByUser' => function ($f) {
  66.                 $db = \Pimcore\Db::get();
  67.                 $ids = $db->fetchCol('SELECT id FROM users where name LIKE '.$db->quote('%'.$f->value.'%')) ?: [0];
  69.                 return ' executedByUser IN( '.implode(',', $ids).') ';
  70.             }
  71.         ];
  72.         if ($filterCondition = QueryParams::getFilterCondition(
  73.             $request->get('filter'),
  74.             ['id', 'o_id', 'pid'],
  75.             true,
  76.             $callbacks
  77.         )
  78.         ) {
  79.             $list->setCondition($filterCondition);
  80.         }
  82.         $condition = $list->getCondition();
  83.         if($filters = $request->get('filter')){
  84.             foreach(json_decode($filters,true) as $e){
  85.                 if($e['property'] == 'id'){
  86.                     $condition .= ' OR `parentId` = ' . (int)$e['value'].' ';
  87.                 }
  88.             }
  89.         }
  91.         if (!$request->get('showHidden') || $request->get('showHidden') == 'false') {
  92.             $filterConditionArray =  QueryParams::getFilterCondition($request->get('filter'), ['id', 'o_id', 'pid'], false, $callbacks);
  94.             if ($filterConditionArray && isset($filterConditionArray['id'])) {
  95.             } else {
  96.                 if ($condition) {
  97.                     $condition .= ' AND published=1';
  98.                 } else {
  99.                     $condition .= ' published=1';
  100.                 }
  101.             }
  102.         }
  103.         $list->setCondition($condition);
  105.         $total = $list->getTotalCount();
  107.         foreach ($list->load() as $item) {
  108.             $data[] = $this->getItemData($item);
  109.         }
  111.         return $this->adminJson(['success' => true, 'total' => $total, 'data' => $data]);
  112.     }
  114.     /**
  115.      * @Route("/update")
  116.      *
  117.      * @param Request $request
  118.      *
  119.      * @return JsonResponse
  120.      */
  121.     public function update(Request $request){
  123.         $monitoringItem = MonitoringItem::getById($request->get('id'));
  125.         $data = [];
  127.         if($monitoringItem){
  128.             if($monitoringItem->getExecutedByUser() == $this->getUser()->getId()){
  129.                 foreach($request->request->all() as $key => $value){
  130.                     $setter = "set" . ucfirst($key);
  131.                     if(method_exists($monitoringItem,$setter)){
  132.                         $monitoringItem->$setter($value);
  133.                     }
  134.                 }
  135.                 $monitoringItem->save();
  136.             }
  137.             $data = $this->getItemData($monitoringItem);
  138.         }
  140.         return $this->json(['success' => true,'data' => $data]);
  142.     }
  144.     /**
  145.      * @return MonitoringItem\Listing
  146.      */
  147.     protected function getProcessesForCurrentUser(){
  148.         $list = new MonitoringItem\Listing();
  149.         $list->setOrder('DESC');
  150.         $list->setOrderKey('id');
  151.         #$list->setLimit(10);
  153.         $list->setCondition('executedByUser = ? and parentId IS NULL AND published = 1 ',[$this->getUser()->getId()]);
  154.         return $list;
  155.     }
  159.     /**
  160.      * @Route("/update-all-user-monitoring-items")
  161.      *
  162.      * @param Request $request
  163.      *
  164.      * @return JsonResponse
  165.      */
  166.     public function updateAllUserMonitoringItems(Request $request){
  168.         $list = $this->getProcessesForCurrentUser();
  169.         $params = $request->request->all();
  170.         /**
  171.          * @var MonitoringItem $item
  172.          */
  173.         foreach($list->load() as $item){
  174.             $item->setValues($params)->save();
  175.         }
  177.         return $this->adminJson(['success' => true]);
  178.     }
  180.     /**
  181.      * @Route("/list-processes-for-user")
  182.      *
  183.      * @param Request $request
  184.      *
  185.      * @return JsonResponse
  186.      */
  187.     public function listProcessesForUser(Request $request){
  188.         $data = [
  189.             'total' => 0,
  190.             'active' => 0,
  191.             'items' => []
  192.         ];
  194.         try {
  195.             $this->checkPermission(Enums\Permissions::VIEW);
  196.         }catch (\Exception $e){
  197.             return $this->adminJson($data);
  198.         }
  200.         $list = $this->getProcessesForCurrentUser();
  202.         $data['total'] = $list->getTotalCount();
  204.         foreach($list->load() as $item){
  205.             $tmp = $this->getItemData($item);
  206.             if($tmp['isAlive']){
  207.                 $data['active']++;
  208.             }
  209.             $data['items'][] = $tmp;
  210.         }
  212.         return $this->adminJson($data);
  213.     }
  215.     protected function getItemData(MonitoringItem $item){
  216.         $tmp = $item->getObjectVars();
  217.         $tmp['messageShort'] = \Pimcore\Tool\Text::cutStringRespectingWhitespace($tmp['message'],30);
  218.         $tmp['steps'] = '-';
  219.         if ($item->getTotalSteps() > 0 || $item->getCurrentStep()) {
  220.             $tmp['steps'] = $item->getCurrentStep().'/'.$item->getTotalSteps();
  221.         }
  222.         $tmp['duration'] = $item->getDuration() ?: '-';
  223.         $tmp['progress'] = 0;
  225.         if ($tmp['executedByUser']) {
  226.             $user = \Pimcore\Model\User::getById($tmp['executedByUser']);
  227.             if ($user) {
  228.                 $tmp['executedByUser'] = $user->getName();
  229.             } else {
  230.                 $tmp['executedByUser'] = 'User id: '.$tmp['executedByUser'];
  231.             }
  232.         } else {
  233.             $tmp['executedByUser'] = 'System';
  234.         }
  236.         $logFile = 0;
  237.         $tmp['action'] = '';
  239.         if ($actions = $item->getActions()) {
  240.             foreach ($actions as $action) {
  241.                 /**
  242.                  * @var $class AbstractAction
  243.                  */
  244.                 $class = new $action['class'];
  245.                 if ($s = $class->getGridActionHtml($item, $action)) {
  246.                     $tmp['action'] .= $s;
  247.                 }
  248.             }
  249.         }
  250.         $tmp['actionItems'] = [];
  252.         if($tmp['actions']){
  253.             $actionItems = json_decode($tmp['actions'],true);
  255.             foreach($actionItems as $i => $v){
  256.                 if($class = $v['class']){
  257.                     if(\Pimcore\Tool::classExists($class)){
  258.                         $o = new $class();
  259.                         $v['dynamicData'] = $o->toJson($item,$v);
  260.                     }
  262.                     $actionItems[$i] = $v;
  263.                 }
  264.             }
  265.             $tmp['actionItems'] = $actionItems;
  266.         }
  267.         $tmp['logger'] = '';
  268.         if ($loggers = $item->getLoggers()) {
  269.             foreach ((array)$loggers as $i => $logger) {
  270.                 /**
  271.                  * @var $class AbstractLogger
  272.                  */
  273.                 $class = new $logger['class'];
  274.                 if (\Pimcore\Tool::classExists(get_class($class))) {
  275.                     $logger['index'] = $i;
  276.                     if ($s = $class->getGridLoggerHtml($item, $logger)) {
  277.                         $tmp['logger'] .= $s;
  278.                     }
  279.                 }
  280.             }
  281.         }
  283.         $tmp['retry'] = 1;
  284.         if ($item->isAlive()) {
  285.             $tmp['retry'] = 0;
  286.         }
  288.         if ($tmp['retry'] == 1) {
  289.             $config = Configuration::getById($item->getConfigurationId());
  290.             if ($config) {
  291.                 if ($config->getActive() == 0) {
  292.                     $tmp['retry'] = 0;
  293.                 } else {
  294.                         $uniqueExecution = $config->getExecutorClassObject()->getValues()['uniqueExecution'] ?? false;
  295.                         if ($uniqueExecution) {
  296.                         $runningProcesses = $config->getRunningProcesses();
  297.                         if (!empty($runningProcesses)) {
  298.                             $tmp['retry'] = 0;
  300.                         }
  301.                     }
  302.                 }
  303.             }
  304.         }
  305.         $tmp['isAlive'] = $item->isAlive();
  307.         $tmp['progress'] = '-';
  308.         if ($item->getCurrentWorkload() && $item->getTotalWorkload()) {
  309.             $progress = $item->getProgressPercentage();
  310.             $tmp['progress'] = '<div class="x-progress x-progress-default x-border-box" style="width:100%;"><div class="x-progress-text x-progress-text-back" ></div><div class="x-progress-bar x-progress-bar-default" style="width:'.$progress.'%;min-width: 35px; "><div class="x-progress-text" style="text-align:left;margin-left: 5px;"><div>'.$progress.'%</div></div></div></div>';
  311.         }
  313.         $tmp['progressPercentage'] = (float)$item->getProgressPercentage();
  314.         $tmp['callbackSettingsString'] = json_encode($item->getCallbackSettings());
  315.         $tmp['callbackSettings'] = $item->getCallbackSettingsForGrid();
  316.         return $tmp;
  317.     }
  319.     /**
  320.      * @Route("/log-application-logger")
  321.      *
  322.      * @param Request $request
  323.      *
  324.      * @return JsonResponse
  325.      */
  326.     public function logApplicationLoggerAction(Request $request)
  327.     {
  328.         try {
  329.             $monitoringItem = MonitoringItem::getById($request->get('id'));
  331.             if (!$monitoringItem) {
  332.                 throw new \Exception('Monitoring Item with id'.$request->get('id').' not found');
  333.             }
  334.             $loggerIndex = $request->get('loggerIndex');
  335.             if ($loggers = $monitoringItem->getLoggers()) {
  336.                 foreach ((array)$loggers as $i => $config) {
  337.                     /**
  338.                      * @var $class AbstractLogger
  339.                      * @var $logger Application
  340.                      */
  341.                     $class = new $config['class'];
  342.                     if (\Pimcore\Tool::classExists(get_class($class))) {
  343.                         if ($i == $loggerIndex) {
  344.                             $logger = $class;
  345.                             if (!$config['logLevel']) {
  346.                                 $config['logLevel'] = 'DEBUG';
  347.                             }
  348.                             break;
  349.                         }
  350.                     }
  351.                 }
  352.             }
  354.             $result = $monitoringItem->getObjectVars();
  355.             $result['logLevel'] = strtolower($config['logLevel']);
  357.             return $this->adminJson(['success' => true, 'data' => $result]);
  358.         } catch (\Exception $e) {
  359.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  360.         }
  361.     }
  363.     /**
  364.      * @Route("/log-file-logger")
  365.      *
  366.      * @param Request $request
  367.      *
  368.      * @return \Symfony\Component\HttpFoundation\Response
  369.      */
  370.     public function logFileLoggerAction(Request $request, ?Profiler $profiler)
  371.     {
  372.         if(null !== $profiler) {
  373.             $profiler->disable();
  374.         }
  375.         $viewData = [];
  376.         $monitoringItem = MonitoringItem::getById($request->get('id'));
  378.         $loggerIndex = $request->get('loggerIndex');
  379.         if ($loggers = $monitoringItem->getLoggers()) {
  380.             foreach ((array)$loggers as $i => $config) {
  381.                 /**
  382.                  * @var $class AbstractLogger
  383.                  * @var $logger File
  384.                  */
  385.                 $class = new $config['class'];
  386.                 if (\Pimcore\Tool::classExists(get_class($class))) {
  387.                     if ($i == $loggerIndex) {
  388.                         $logger = $class;
  389.                         $logFile = $logger->getLogFile($config, $monitoringItem);
  390.                         if (!$config['logLevel']) {
  391.                             $config['logLevel'] = 'DEBUG';
  392.                         }
  393.                         break;
  394.                     }
  395.                 }
  396.             }
  397.         }
  398.         $viewData['logLevel'] = $config['logLevel'];
  399.         $viewData['logFile'] = $logFile;
  401.         if (is_readable($logFile)) {
  402.             $data = file_get_contents($logFile);
  403.             if(array_key_exists("disableFileProcessing",$config) && $config['disableFileProcessing']){
  404.                 return new \Symfony\Component\HttpFoundation\Response($data);
  405.             }
  408.             $fileSizeMb = round(filesize($logFile) / 1024 / 1024);
  410.             if ($fileSizeMb < 100) {
  411.                 $data = file_get_contents($logFile);
  412.                 $data = explode("\n", $data);
  413.             } else {
  414.                 $data = explode("\n", shell_exec('tail -n 1000 ' . $logFile));
  415.                 $warning = '<span style="color:#ff131c">The log file is to large to view all contents (' . $fileSizeMb.'MB). The last 1000 lines are displayed. File: ' . $logFile . '</span>';
  416.                 array_unshift($data, $warning);
  417.                 array_push($data, $warning);
  418.             }
  420.             foreach ($data as $i => $row) {
  421.                 if ($row) {
  422.                     if (strpos($row, '.WARNING')) {
  423.                         $data[$i] = '<span style="color:#ffb13b">'.$row.'</span>';
  424.                     }
  425.                     if (strpos($row, '.ERROR') || strpos($row, '.CRITICAL')) {
  426.                         $data[$i] = '<span style="color:#ff131c">'.$row.'</span>';
  427.                     }
  428.                     if (strpos($row, 'dev-server > ') === 0 || strpos($row, 'production-server > ') === 0) {
  429.                         $data[$i] = '<span style="color:#35ad33">'.$row.'</span>';
  430.                     }
  431.                     foreach (['[echo]', '[mkdir]', '[delete]', '[copy]'] as $k) {
  432.                         if (strpos($row, $k)) {
  433.                             $data[$i] = '<span style="color:#49b7d4">'.$row.'</span>';
  434.                         }
  435.                     }
  436.                 }
  437.             }
  438.         } else {
  439.             $data = ["Log file doesn't exist. ".$logFile];
  440.         }
  441.         $data = implode("\n", $data);
  443.         $viewData['data'] = $data;
  444.         $viewData['monitoringItem'] = $monitoringItem;
  445.         return $this->render('@ElementsProcessManager/MonitoringItem/logFileLogger.html.twig', $viewData);
  446.     }
  448.     /**
  449.      * @Route("/delete")
  450.      *
  451.      * @param Request $request
  452.      *
  453.      * @return JsonResponse
  454.      */
  455.     public function deleteAction(Request $request)
  456.     {
  457.         $this->checkPermission('plugin_pm_permission_delete_monitoring_item');
  458.         $entry = MonitoringItem::getById($request->get('id'));
  459.         if ($entry) {
  460.             if($entry->isAlive()){
  461.                 $entry->stopProcess();
  462.             }
  463.             $entry->delete();
  465.             return $this->adminJson(['success' => true]);
  466.         }
  468.         return $this->adminJson(['success' => false, 'message' => "Couldn't delete entry"]);
  469.     }
  471.     /**
  472.      * @Route("/delete-batch")
  473.      *
  474.      * @param Request $request
  475.      *
  476.      * @return JsonResponse
  477.      */
  478.     public function deleteBatchAction(Request $request)
  479.     {
  480.         $this->checkPermission('plugin_pm_permission_delete_monitoring_item');
  481.         $logLevels = array_filter(explode(',', $request->get('logLevels')));
  482.         if (!empty($logLevels)) {
  483.             $list = new MonitoringItem\Listing();
  484.             $conditions = [];
  485.             foreach ($logLevels as $loglevel) {
  486.                 $conditions[] = ' status ="'.$loglevel.'" ';
  487.             }
  488.             $condition = implode(' OR ', $conditions);
  489.             $list->setCondition($condition);
  490.             $items = $list->load();
  491.             foreach ($items as $item) {
  492.                 $item->delete();
  493.             }
  495.             return $this->adminJson(['success' => true]);
  496.         } else {
  497.             return $this->adminJson(
  498.                 [
  499.                     'success' => false,
  500.                     'message' => 'No statuses -> didn\'t deleted logs. Please select at least one status',
  501.                 ]
  502.             );
  503.         }
  504.     }
  506.     /**
  507.      * @Route("/cancel")
  508.      *
  509.      * @param Request $request
  510.      *
  511.      * @return JsonResponse
  512.      */
  513.     public function cancelAction(Request $request)
  514.     {
  515.         $monitoringItem = MonitoringItem::getById($request->get('id'));
  516.         try {
  517.             $pid = $monitoringItem->getPid();
  518.             if ($pid) {
  519.                 $status = $monitoringItem->stopProcess();
  520.                 $message = 'Process with PID "'.$pid.'" killed by Backend User: '.$this->getUser()->getUser()->getName();
  521.                 $monitoringItem->getLogger()->warning($message);
  522.                 foreach($monitoringItem->getChildProcesses() as $child) {
  523.                     $child->stopProcess();
  524.                 }
  525.                 return $this->adminJson(['success' => $status]);
  526.             }
  528.             return $this->adminJson(['success' => true]);
  529.         } catch (\Exception $e) {
  530.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  531.         }
  532.     }
  534.     /**
  535.      * @Route("/restart")
  536.      *
  537.      * @param Request $request
  538.      *
  539.      * @return JsonResponse
  540.      */
  541.     public function restartAction(Request $request)
  542.     {
  543.         try {
  544.             $monitoringItem = MonitoringItem::getById($request->get('id'));
  545.             $monitoringItem->deleteLogFile()->resetState()->save();
  546.             putenv(ElementsProcessManagerBundle::MONITORING_ITEM_ENV_VAR . '=' . $monitoringItem->getId());
  547.             $pid = \Pimcore\Tool\Console::execInBackground($monitoringItem->getCommand(), $monitoringItem->getLogFile());
  548.             $monitoringItem->setPid($pid)->save();
  549.             return $this->adminJson(['success' => true,'PID' => $pid]);
  550.         } catch (\Exception $e) {
  551.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  552.         }
  553.     }
  555.     /**
  556.      * @Route("/get-by-id")
  557.      *
  558.      * @param Request $request
  559.      *
  560.      * @return JsonResponse
  561.      */
  562.     public function getByIdAction(Request $request){
  563.         $data = [];
  565.         $item = MonitoringItem::getById($request->get('id'));
  566.         $data = $item->getObjectVars();
  567.         $data['callbackSettings'] = json_decode($data['callbackSettings']);
  568.         $data['executorSettings']['values'] = [];
  569.         return $this->adminJson($data);
  571.     }
  573. }