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

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\Message\ExecuteCommandMessage;
  23. use Elements\Bundle\ProcessManagerBundle\Model\Configuration;
  24. use Elements\Bundle\ProcessManagerBundle\Model\MonitoringItem;
  25. use Pimcore\Bundle\AdminBundle\Controller\AdminController;
  26. use Pimcore\Bundle\AdminBundle\Helper\QueryParams;
  27. use Pimcore\Templating\Model\ViewModel;
  28. use Symfony\Component\HttpFoundation\JsonResponse;
  29. use Symfony\Component\HttpFoundation\Request;
  30. use Symfony\Component\HttpKernel\Profiler\Profiler;
  31. use Symfony\Component\Messenger\MessageBusInterface;
  32. use Symfony\Component\Routing\Annotation\Route;
  33. use Elements\Bundle\ProcessManagerBundle\ElementsProcessManagerBundle;
  34. use Elements\Bundle\ProcessManagerBundle\Enums;
  35. /**
  36.  * @Route("/admin/elementsprocessmanager/monitoring-item")
  37.  */
  38. class MonitoringItemController extends AdminController
  39. {
  40.     /**
  41.      * @Route("/list")
  42.      *
  43.      * @param Request $request
  44.      *
  45.      * @return JsonResponse
  46.      */
  47.     public function listAction(Request $request)
  48.     {
  49.         $this->checkPermission(Enums\Permissions::VIEW);
  50.         $data = [];
  51.         $list = new MonitoringItem\Listing();
  52.         $list->setOrder('DESC');
  53.         $list->setOrderKey('id');
  54.         $list->setLimit($request->get('limit', 25));
  55.         $list->setUser($this->getAdminUser());
  57.         $list->setOffset($request->get('start'));
  59.         $allParams = array_merge($request->request->all(), $request->query->all());
  60.         $sortingSettings = QueryParams::extractSortingSettings($allParams);
  61.         if ($sortingSettings['orderKey'] && $sortingSettings['order']) {
  62.             $list->setOrderKey($sortingSettings['orderKey']);
  63.             $list->setOrder($sortingSettings['order']);
  64.         }
  66.         $callbacks = [
  67.             'executedByUser' => function ($f) {
  68.                 $db = \Pimcore\Db::get();
  69.                 $ids = $db->fetchCol('SELECT id FROM users where name LIKE '.$db->quote('%'.$f->value.'%')) ?: [0];
  71.                 return ' executedByUser IN( '.implode(',', $ids).') ';
  72.             }
  73.         ];
  74.         if ($filterCondition = QueryParams::getFilterCondition(
  75.             $request->get('filter'),
  76.             ['id', 'o_id', 'pid'],
  77.             true,
  78.             $callbacks
  79.         )
  80.         ) {
  81.             $list->setCondition($filterCondition);
  82.         }
  84.         $condition = $list->getCondition();
  85.         if($filters = $request->get('filter')){
  86.             foreach(json_decode($filters,true) as $e){
  87.                 if($e['property'] == 'id'){
  88.                     $condition .= ' OR `parentId` = ' . (int)$e['value'].' ';
  89.                 }
  90.             }
  91.         }
  93.         if (!$request->get('showHidden') || $request->get('showHidden') == 'false') {
  94.             $filterConditionArray =  QueryParams::getFilterCondition($request->get('filter'), ['id', 'o_id', 'pid'], false, $callbacks);
  96.             if ($filterConditionArray && isset($filterConditionArray['id'])) {
  97.             } else {
  98.                 if ($condition) {
  99.                     $condition .= ' AND published=1';
  100.                 } else {
  101.                     $condition .= ' published=1';
  102.                 }
  103.             }
  104.         }
  105.         $list->setCondition($condition);
  107.         $total = $list->getTotalCount();
  109.         foreach ($list->load() as $item) {
  110.             $data[] = $this->getItemData($item);
  111.         }
  113.         return $this->adminJson(['success' => true, 'total' => $total, 'data' => $data]);
  114.     }
  116.     /**
  117.      * @Route("/update")
  118.      *
  119.      * @param Request $request
  120.      *
  121.      * @return JsonResponse
  122.      */
  123.     public function update(Request $request){
  125.         $monitoringItem = MonitoringItem::getById($request->get('id'));
  127.         $data = [];
  129.         if($monitoringItem){
  130.             if($monitoringItem->getExecutedByUser() == $this->getUser()->getId()){
  131.                 foreach($request->request->all() as $key => $value){
  132.                     $setter = "set" . ucfirst($key);
  133.                     if(method_exists($monitoringItem,$setter)){
  134.                         $monitoringItem->$setter($value);
  135.                     }
  136.                 }
  137.                 $monitoringItem->save();
  138.             }
  139.             $data = $this->getItemData($monitoringItem);
  140.         }
  142.         return $this->json(['success' => true,'data' => $data]);
  144.     }
  146.     /**
  147.      * @return MonitoringItem\Listing
  148.      */
  149.     protected function getProcessesForCurrentUser(){
  150.         $list = new MonitoringItem\Listing();
  151.         $list->setOrder('DESC');
  152.         $list->setOrderKey('id');
  153.         #$list->setLimit(10);
  155.         $list->setCondition('executedByUser = ? and parentId IS NULL AND published = 1 ',[$this->getUser()->getId()]);
  156.         return $list;
  157.     }
  161.     /**
  162.      * @Route("/update-all-user-monitoring-items")
  163.      *
  164.      * @param Request $request
  165.      *
  166.      * @return JsonResponse
  167.      */
  168.     public function updateAllUserMonitoringItems(Request $request){
  170.         $list = $this->getProcessesForCurrentUser();
  171.         $params = $request->request->all();
  172.         /**
  173.          * @var MonitoringItem $item
  174.          */
  175.         foreach($list->load() as $item){
  176.             $item->setValues($params)->save();
  177.         }
  179.         return $this->adminJson(['success' => true]);
  180.     }
  182.     /**
  183.      * @Route("/list-processes-for-user")
  184.      *
  185.      * @param Request $request
  186.      *
  187.      * @return JsonResponse
  188.      */
  189.     public function listProcessesForUser(Request $request){
  190.         $data = [
  191.             'total' => 0,
  192.             'active' => 0,
  193.             'items' => []
  194.         ];
  196.         try {
  197.             $this->checkPermission(Enums\Permissions::VIEW);
  198.         }catch (\Exception $e){
  199.             return $this->adminJson($data);
  200.         }
  202.         $list = $this->getProcessesForCurrentUser();
  204.         $data['total'] = $list->getTotalCount();
  206.         foreach($list->load() as $item){
  207.             $tmp = $this->getItemData($item);
  208.             if($tmp['isAlive']){
  209.                 $data['active']++;
  210.             }
  211.             $data['items'][] = $tmp;
  212.         }
  214.         return $this->adminJson($data);
  215.     }
  217.     protected function getItemData(MonitoringItem $item){
  218.         $tmp = $item->getObjectVars();
  219.         $tmp['messageShort'] = \Pimcore\Tool\Text::cutStringRespectingWhitespace($tmp['message'],30);
  220.         $tmp['steps'] = '-';
  221.         if ($item->getTotalSteps() > 0 || $item->getCurrentStep()) {
  222.             $tmp['steps'] = $item->getCurrentStep().'/'.$item->getTotalSteps();
  223.         }
  224.         $tmp['duration'] = $item->getDuration() ?: '-';
  225.         $tmp['progress'] = 0;
  227.         if ($tmp['executedByUser']) {
  228.             $user = \Pimcore\Model\User::getById($tmp['executedByUser']);
  229.             if ($user) {
  230.                 $tmp['executedByUser'] = $user->getName();
  231.             } else {
  232.                 $tmp['executedByUser'] = 'User id: '.$tmp['executedByUser'];
  233.             }
  234.         } else {
  235.             $tmp['executedByUser'] = 'System';
  236.         }
  238.         $logFile = 0;
  239.         $tmp['action'] = '';
  241.         if ($actions = $item->getActions()) {
  242.             foreach ($actions as $action) {
  243.                 /**
  244.                  * @var $class AbstractAction
  245.                  */
  246.                 $class = new $action['class'];
  247.                 if ($s = $class->getGridActionHtml($item, $action)) {
  248.                     $tmp['action'] .= $s;
  249.                 }
  250.             }
  251.         }
  252.         $tmp['actionItems'] = [];
  254.         if($tmp['actions']){
  255.             $actionItems = json_decode($tmp['actions'],true);
  257.             foreach($actionItems as $i => $v){
  258.                 if($class = $v['class']){
  259.                     if(\Pimcore\Tool::classExists($class)){
  260.                         $o = new $class();
  261.                         $v['dynamicData'] = $o->toJson($item,$v);
  262.                     }
  264.                     $actionItems[$i] = $v;
  265.                 }
  266.             }
  267.             $tmp['actionItems'] = $actionItems;
  268.         }
  269.         $tmp['logger'] = '';
  270.         if ($loggers = $item->getLoggers()) {
  271.             foreach ((array)$loggers as $i => $logger) {
  272.                 /**
  273.                  * @var $class AbstractLogger
  274.                  */
  275.                 $class = new $logger['class'];
  276.                 if (\Pimcore\Tool::classExists(get_class($class))) {
  277.                     $logger['index'] = $i;
  278.                     if ($s = $class->getGridLoggerHtml($item, $logger)) {
  279.                         $tmp['logger'] .= $s;
  280.                     }
  281.                 }
  282.             }
  283.         }
  285.         $tmp['retry'] = 1;
  286.         if ($item->isAlive()) {
  287.             $tmp['retry'] = 0;
  288.         }
  290.         if ($tmp['retry'] == 1) {
  291.             $config = Configuration::getById($item->getConfigurationId());
  292.             if ($config) {
  293.                 if ($config->getActive() == 0) {
  294.                     $tmp['retry'] = 0;
  295.                 } else {
  296.                         $uniqueExecution = $config->getExecutorClassObject()->getValues()['uniqueExecution'] ?? false;
  297.                         if ($uniqueExecution) {
  298.                         $runningProcesses = $config->getRunningProcesses();
  299.                         if (!empty($runningProcesses)) {
  300.                             $tmp['retry'] = 0;
  302.                         }
  303.                     }
  304.                 }
  305.             }
  306.         }
  307.         $tmp['isAlive'] = $item->isAlive();
  309.         $tmp['progress'] = '-';
  310.         if ($item->getCurrentWorkload() && $item->getTotalWorkload()) {
  311.             $progress = $item->getProgressPercentage();
  312.             $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>';
  313.         }
  315.         $tmp['progressPercentage'] = (float)$item->getProgressPercentage();
  316.         $tmp['callbackSettingsString'] = json_encode($item->getCallbackSettings());
  317.         $tmp['callbackSettings'] = $item->getCallbackSettingsForGrid();
  318.         return $tmp;
  319.     }
  321.     /**
  322.      * @Route("/log-application-logger")
  323.      *
  324.      * @param Request $request
  325.      *
  326.      * @return JsonResponse
  327.      */
  328.     public function logApplicationLoggerAction(Request $request)
  329.     {
  330.         try {
  331.             $monitoringItem = MonitoringItem::getById($request->get('id'));
  333.             if (!$monitoringItem) {
  334.                 throw new \Exception('Monitoring Item with id'.$request->get('id').' not found');
  335.             }
  336.             $loggerIndex = $request->get('loggerIndex');
  337.             if ($loggers = $monitoringItem->getLoggers()) {
  338.                 foreach ((array)$loggers as $i => $config) {
  339.                     /**
  340.                      * @var $class AbstractLogger
  341.                      * @var $logger Application
  342.                      */
  343.                     $class = new $config['class'];
  344.                     if (\Pimcore\Tool::classExists(get_class($class))) {
  345.                         if ($i == $loggerIndex) {
  346.                             $logger = $class;
  347.                             if (!$config['logLevel']) {
  348.                                 $config['logLevel'] = 'DEBUG';
  349.                             }
  350.                             break;
  351.                         }
  352.                     }
  353.                 }
  354.             }
  356.             $result = $monitoringItem->getObjectVars();
  357.             $result['logLevel'] = strtolower($config['logLevel']);
  359.             return $this->adminJson(['success' => true, 'data' => $result]);
  360.         } catch (\Exception $e) {
  361.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  362.         }
  363.     }
  365.     /**
  366.      * @Route("/log-file-logger")
  367.      *
  368.      * @param Request $request
  369.      *
  370.      * @return \Symfony\Component\HttpFoundation\Response
  371.      */
  372.     public function logFileLoggerAction(Request $request, ?Profiler $profiler)
  373.     {
  374.         if(null !== $profiler) {
  375.             $profiler->disable();
  376.         }
  377.         $viewData = [];
  378.         $monitoringItem = MonitoringItem::getById($request->get('id'));
  380.         $loggerIndex = $request->get('loggerIndex');
  381.         if ($loggers = $monitoringItem->getLoggers()) {
  382.             foreach ((array)$loggers as $i => $config) {
  383.                 /**
  384.                  * @var $class AbstractLogger
  385.                  * @var $logger File
  386.                  */
  387.                 $class = new $config['class'];
  388.                 if (\Pimcore\Tool::classExists(get_class($class))) {
  389.                     if ($i == $loggerIndex) {
  390.                         $logger = $class;
  391.                         $logFile = $logger->getLogFile($config, $monitoringItem);
  392.                         if (!$config['logLevel']) {
  393.                             $config['logLevel'] = 'DEBUG';
  394.                         }
  395.                         break;
  396.                     }
  397.                 }
  398.             }
  399.         }
  400.         $viewData['logLevel'] = $config['logLevel'];
  401.         $viewData['logFile'] = $logFile;
  403.         if (is_readable($logFile)) {
  404.             $data = file_get_contents($logFile);
  405.             if(array_key_exists("disableFileProcessing",$config) && $config['disableFileProcessing']){
  406.                 return new \Symfony\Component\HttpFoundation\Response($data);
  407.             }
  410.             $fileSizeMb = round(filesize($logFile) / 1024 / 1024);
  412.             if ($fileSizeMb < 100) {
  413.                 $data = file_get_contents($logFile);
  414.                 $data = explode("\n", $data);
  415.             } else {
  416.                 $data = explode("\n", shell_exec('tail -n 1000 ' . $logFile));
  417.                 $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>';
  418.                 array_unshift($data, $warning);
  419.                 array_push($data, $warning);
  420.             }
  422.             foreach ($data as $i => $row) {
  423.                 if ($row) {
  424.                     if (strpos($row, '.WARNING')) {
  425.                         $data[$i] = '<span style="color:#ffb13b">'.$row.'</span>';
  426.                     }
  427.                     if (strpos($row, '.ERROR') || strpos($row, '.CRITICAL')) {
  428.                         $data[$i] = '<span style="color:#ff131c">'.$row.'</span>';
  429.                     }
  430.                     if (strpos($row, 'dev-server > ') === 0 || strpos($row, 'production-server > ') === 0) {
  431.                         $data[$i] = '<span style="color:#35ad33">'.$row.'</span>';
  432.                     }
  433.                     foreach (['[echo]', '[mkdir]', '[delete]', '[copy]'] as $k) {
  434.                         if (strpos($row, $k)) {
  435.                             $data[$i] = '<span style="color:#49b7d4">'.$row.'</span>';
  436.                         }
  437.                     }
  438.                 }
  439.             }
  440.         } else {
  441.             $data = ["Log file doesn't exist. ".$logFile];
  442.         }
  443.         $data = implode("\n", $data);
  445.         $viewData['data'] = $data;
  446.         $viewData['monitoringItem'] = $monitoringItem;
  447.         return $this->render('@ElementsProcessManager/MonitoringItem/logFileLogger.html.twig', $viewData);
  448.     }
  450.     /**
  451.      * @Route("/delete")
  452.      *
  453.      * @param Request $request
  454.      *
  455.      * @return JsonResponse
  456.      */
  457.     public function deleteAction(Request $request)
  458.     {
  459.         $this->checkPermission('plugin_pm_permission_delete_monitoring_item');
  460.         $entry = MonitoringItem::getById($request->get('id'));
  461.         if ($entry) {
  462.             if($entry->isAlive()){
  463.                 $entry->stopProcess();
  464.             }
  465.             $entry->delete();
  467.             return $this->adminJson(['success' => true]);
  468.         }
  470.         return $this->adminJson(['success' => false, 'message' => "Couldn't delete entry"]);
  471.     }
  473.     /**
  474.      * @Route("/delete-batch")
  475.      *
  476.      * @param Request $request
  477.      *
  478.      * @return JsonResponse
  479.      */
  480.     public function deleteBatchAction(Request $request)
  481.     {
  482.         $this->checkPermission('plugin_pm_permission_delete_monitoring_item');
  483.         $logLevels = array_filter(explode(',', $request->get('logLevels')));
  484.         if (!empty($logLevels)) {
  485.             $list = new MonitoringItem\Listing();
  486.             $conditions = [];
  487.             foreach ($logLevels as $loglevel) {
  488.                 $conditions[] = ' status ="'.$loglevel.'" ';
  489.             }
  490.             $condition = implode(' OR ', $conditions);
  491.             $list->setCondition($condition);
  492.             $items = $list->load();
  493.             foreach ($items as $item) {
  494.                 $item->delete();
  495.             }
  497.             return $this->adminJson(['success' => true]);
  498.         } else {
  499.             return $this->adminJson(
  500.                 [
  501.                     'success' => false,
  502.                     'message' => 'No statuses -> didn\'t deleted logs. Please select at least one status',
  503.                 ]
  504.             );
  505.         }
  506.     }
  508.     /**
  509.      * @Route("/cancel")
  510.      *
  511.      * @param Request $request
  512.      *
  513.      * @return JsonResponse
  514.      */
  515.     public function cancelAction(Request $request)
  516.     {
  517.         $monitoringItem = MonitoringItem::getById($request->get('id'));
  518.         try {
  519.             $pid = $monitoringItem->getPid();
  520.             if ($pid) {
  521.                 $status = $monitoringItem->stopProcess();
  522.                 $message = 'Process with PID "'.$pid.'" killed by Backend User: '.$this->getUser()->getUser()->getName();
  523.                 $monitoringItem->getLogger()->warning($message);
  524.                 foreach($monitoringItem->getChildProcesses() as $child) {
  525.                     $child->stopProcess();
  526.                 }
  527.                 return $this->adminJson(['success' => $status]);
  528.             }
  530.             return $this->adminJson(['success' => true]);
  531.         } catch (\Exception $e) {
  532.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  533.         }
  534.     }
  536.     /**
  537.      * @Route("/restart")
  538.      *
  539.      * @param Request $request
  540.      *
  541.      * @return JsonResponse
  542.      */
  543.     public function restartAction(Request $request, MessageBusInterface $messageBus)
  544.     {
  545.         try {
  546.             $monitoringItem = MonitoringItem::getById($request->get('id'));
  547.             $monitoringItem->setMessengerPending(true);
  548.             $monitoringItem->deleteLogFile()->resetState()->save();
  549.             putenv(ElementsProcessManagerBundle::MONITORING_ITEM_ENV_VAR . '=' . $monitoringItem->getId());
  551.             $message = new ExecuteCommandMessage($monitoringItem->getCommand(), $monitoringItem->getId(), $monitoringItem->getLogFile());
  552.             $messageBus->dispatch($message);
  553. ;
  554.             return $this->adminJson(['success' => true]);
  555.         } catch (\Exception $e) {
  556.             return $this->adminJson(['success' => false, 'message' => $e->getMessage()]);
  557.         }
  558.     }
  560.     /**
  561.      * @Route("/get-by-id")
  562.      *
  563.      * @param Request $request
  564.      *
  565.      * @return JsonResponse
  566.      */
  567.     public function getByIdAction(Request $request){
  568.         $data = [];
  570.         $item = MonitoringItem::getById($request->get('id'));
  571.         $data = $item->getObjectVars();
  572.         $data['callbackSettings'] = json_decode($data['callbackSettings']);
  573.         $data['executorSettings']['values'] = [];
  574.         return $this->adminJson($data);
  576.     }
  578. }