Improved logging, richer stack traces

.travis.yml

@@ -1,6 +1,5 @@
 language: php
 os: linux
-sudo: required
 
 matrix:
   fast_finish: true

Api/Core/Config/ApiConfig.php

@@ -18,7 +18,6 @@ class ApiConfig
 
     const OAUTH2_PRIVATE_KEY = 'Api/V8/OAuth2/private.key';
     const OAUTH2_PUBLIC_KEY = 'Api/V8/OAuth2/public.key';
-    const OAUTH2_ENCRYPTION_KEY = '';
 
     /**
      *

Api/V8/Config/services/middlewares.php

@@ -35,24 +35,16 @@
             sprintf('file://%s/%s', $baseDir, ApiConfig::OAUTH2_PUBLIC_KEY)
         );
 
-        if (empty(ApiConfig::OAUTH2_ENCRYPTION_KEY)) {
-            $oldKey = "OAUTH2_ENCRYPTION_KEY = '" . ApiConfig::OAUTH2_ENCRYPTION_KEY;
-            $key = "OAUTH2_ENCRYPTION_KEY = '" . base64_encode(random_bytes(32));
-            $apiConfig = file_get_contents('Api/Core/Config/ApiConfig.php');
-
-            $configFileContents = str_replace(
-                $oldKey,
-                $key,
-                $apiConfig
-            );
-            file_put_contents(
-                'Api/Core/Config/ApiConfig.php',
-                $configFileContents,
-                LOCK_EX
-            );
+        $oauth2EncKey = isset($GLOBALS['sugar_config']['oauth2_encryption_key'])
+            ? $GLOBALS['sugar_config']['oauth2_encryption_key'] : '';
+        if (empty($oauth2EncKey)) {
+            $oauth2EncKey = 'SCRM-DEFK';
+            if (isset($GLOBALS['log'])) {
+                $GLOBALS['log']->fatal('WARNING: `oauth2_encryption_key` not set in config.php');
+            }
         }
 
-        $server->setEncryptionKey(ApiConfig::OAUTH2_ENCRYPTION_KEY);
+        $server->setEncryptionKey($oauth2EncKey);
 
         // Client credentials grant
         $server->enableGrantType(

Api/V8/OAuth2/Entity/UserEntity.php

@@ -5,12 +5,24 @@
 
 class UserEntity implements UserEntityInterface
 {
+    /**
+     * @var $userId
+     */
+    private $userId;
+
+    /**
+     * @param string $userId
+     */
+    public function __construct($userId)
+    {
+        $this->userId = $userId;
+    }
+
     /**
      * @inheritdoc
      */
     public function getIdentifier()
     {
-        // we skip this right now, since we are not using scopes atm
-        return true;
+        return $this->userId;
     }
 }

Api/V8/OAuth2/Repository/AccessTokenRepository.php

@@ -62,19 +62,9 @@ public function persistNewAccessToken(AccessTokenEntityInterface $accessTokenEnt
         /** @var User $user */
         $client = $this->beanManager->getBeanSafe('OAuth2Clients', $clientId);
 
-        /** @var User $user */
-        $user = $this->beanManager->newBeanSafe('Users');
-
         switch ($client->allowed_grant_type) {
             case 'password':
-                if (!empty($_POST['username'])) {
-                    /** @var User $user */
-                    $user = $this->beanManager->newBeanSafe('Users');
-                    $user->retrieve_by_string_fields(
-                        ['user_name' => $_POST['username']]
-                    );
-                    $userId = $user->id;
-                }
+                $userId = $accessTokenEntity->getUserIdentifier();
                 break;
             case 'client_credentials':
                 $userId = $client->assigned_user_id;
@@ -85,8 +75,6 @@ public function persistNewAccessToken(AccessTokenEntityInterface $accessTokenEnt
             throw new InvalidArgumentException('No user found');
         }
 
-        $userId = !empty($user->id) ? $user->id : $client->assigned_user_id;
-
         /** @var OAuth2Tokens $token */
         $token = $this->beanManager->newBeanSafe(OAuth2Tokens::class);
 

Api/V8/OAuth2/Repository/UserRepository.php

@@ -46,6 +46,6 @@ public function getUserEntityByUserCredentials(
             throw new \InvalidArgumentException('The password is invalid: ' . $password);
         }
 
-        return new UserEntity();
+        return new UserEntity($user->id);
     }
 }

Api/V8/Service/ModuleService.php

@@ -2,6 +2,7 @@
 
 namespace Api\V8\Service;
 
+use Api\V8\BeanDecorator\BeanListResponse;
 use Api\V8\BeanDecorator\BeanManager;
 use Api\V8\JsonApi\Helper\AttributeObjectHelper;
 use Api\V8\JsonApi\Helper\PaginationObjectHelper;
@@ -91,6 +92,7 @@ public function getRecord(GetModuleParams $params, $path)
      */
     public function getRecords(GetModulesParams $params, Request $request)
     {
+        global $db;
         // this whole method should split into separated classes later
         $module = $params->getModuleName();
         $orderBy = $params->getSort();
@@ -118,16 +120,75 @@ public function getRecords(GetModulesParams $params, Request $request)
             $fields = $this->beanManager->getDefaultFields($bean);
         }
 
-        $beanListResponse = $this->beanManager->getList($module)
-            ->orderBy($orderBy)
-            ->where($where)
-            ->offset($offset)
-            ->limit($limit)
-            ->max($size)
-            ->deleted($deleted)
-            ->fields($this->beanManager->filterAcceptanceFields($bean, $fields))
-            ->fetch();
+        // Detect if bean has email field
+        if ((property_exists($bean, 'email1')
+                && strpos($where, 'email1') !== false)
+            || (property_exists($bean, 'email2')
+                && strpos($where, 'email2') !== false)
+        ) {
+
+            $selectedModule = strtolower($module);
+
+            // Selects Module or COUNT(*) and will add one to the query.
+            $idSelect = 'SELECT ' . $selectedModule . '.id ';
+            $countSelect = 'SELECT COUNT(*) AS cnt ';
+
+            $quotedCountSelect = $db->quote($countSelect);
+
+            // Email where clause
+            $fromQuery
+                = 'FROM email_addresses JOIN email_addr_bean_rel ON email_addresses.id = email_addr_bean_rel.email_address_id JOIN '
+                . $selectedModule . ' ON ' . $selectedModule
+                . '.id = email_addr_bean_rel.bean_id ';
+            $modifiedWhere = str_replace('accounts.email1',
+                'email_addresses.email_address', $where);
+            $where = $modifiedWhere;
+
+            // Sets and adds deleted to the query
+            if ($deleted == 0) {
+                $whereAuto = '' . $bean->table_name . ' .deleted=0';
+            } elseif ($deleted == 1) {
+                $whereAuto = '' . $bean->table_name . ' .deleted=1';
+            }
+            if ($where != '') {
+                $where = ' where (' . $where . ') AND ' . $whereAuto . '';
+            } else {
+                $where = ' where ' . $whereAuto . '';
+            }
+
+            // Joins parts together to form query
+            $query = $idSelect . $fromQuery . $where;
+            $countQuery = $quotedCountSelect . $fromQuery . $where;
+            $realRowCount = (int)$db->fetchRow($db->query($countQuery, true, ''))['cnt'];
+
+            // Sets order by into the query
+            $order_by = $bean->process_order_by($orderBy);
+            if (!empty($orderBy)) {
+                $query .= ' ORDER BY ' . $order_by;
+            }
+
+            $result = $bean->process_list_query($query, $offset, $limit, -1, $where);
+            $beanResult['row_count'] = $result['row_count'];
+            $beanList = [];
 
+            foreach ($result['list'] as $resultBean) {
+                $queryModuleBean = \BeanFactory::newBean($module);
+                $queryModuleBean->id = $resultBean->id;
+                $beanList[] = $queryModuleBean;
+            }
+            $beanResult['list'] = $beanList;
+            $beanListResponse = new BeanListResponse($beanResult);
+        } else {
+            $beanListResponse = $this->beanManager->getList($module)
+                ->orderBy($orderBy)
+                ->where($where)
+                ->offset($offset)
+                ->limit($limit)
+                ->max($size)
+                ->deleted($deleted)
+                ->fields($this->beanManager->filterAcceptanceFields($bean, $fields))
+                ->fetch();
+        }
 
         $beanArray = [];
         foreach ($beanListResponse->getBeans() as $bean) {

data/SugarBean.php

@@ -2065,13 +2065,14 @@ public function get_linked_beans(
                 ));
             }
             // Link2 style
-            if ($end_index != -1 || !empty($deleted) || !empty($optional_where) || !empty($order_by)) {
+            if ($begin_index != 0 || $end_index != -1 || !empty($deleted) || !empty($optional_where) || !empty($order_by)) {
                 return array_values($this->$field_name->getBeans(array(
-                        'where' => $optional_where,
-                        'deleted' => $deleted,
-                        'limit' => ($end_index - $begin_index),
-                        'order_by' => $order_by
-                    )));
+                    'where' => $optional_where,
+                    'deleted' => $deleted,
+                    'offset' => $begin_index,
+                    'limit' => ($end_index - $begin_index),
+                    'order_by' => $order_by
+                )));
             }
             return array_values($this->$field_name->getBeans());
         }

include/MVC/Controller/SugarController.php

@@ -191,6 +191,12 @@ class SugarController
         'listview' => 'ListView'
     );
 
+    public $breadcrumbs = Array(
+        'entryPointFile' => '',
+        'processTasksHistory' => '',
+        'handleActionTasksHistory' => '',
+    );
+
     /**
      * Constructor. This ie meant to load up the module, action, record as well
      * as the mapping arrays.
@@ -453,6 +459,7 @@ public function process()
     {
         $GLOBALS['action'] = $this->action;
         $GLOBALS['module'] = $this->module;
+        $this->breadcrumbs['processTasksHistory'] = '';
 
         //check to ensure we have access to the module.
         if ($this->hasAccess) {
@@ -465,7 +472,9 @@ public function process()
             $processed = false;
             if (!$this->_processed) {
                 foreach ($this->process_tasks as $process) {
+                    $this->breadcrumbs['processTasksHistory'] .= $process . '…';
                     $this->$process();
+                    $this->breadcrumbs['processTasksHistory'] .= 'ok. ';
                     if ($this->_processed) {
                         break;
                     }
@@ -474,6 +483,7 @@ public function process()
 
             $this->redirect();
         } else {
+            $this->breadcrumbs['processTasksHistory'] .= 'no access!';
             $this->no_access();
         }
     }
@@ -489,22 +499,27 @@ public function process()
      */
     protected function handle_action()
     {
+        $this->breadcrumbs['handleActionTasksHistory'] = '';
+
         $processed = false;
         foreach ($this->tasks as $task) {
+            $this->breadcrumbs['handleActionTasksHistory'] .= $task . '…';
             $processed = ($this->$task() || $processed);
+            $this->breadcrumbs['handleActionTasksHistory'] .= 'ok. ';
         }
         $this->_processed = $processed;
     }
 
     /**
      * Perform an action prior to the specified action.
-     * This can be overridde in a sub-class
+     * This can be overridden in a sub-class
      */
     private function pre_action()
     {
         $function = $this->getPreActionMethodName();
         if ($this->hasFunction($function)) {
-            $GLOBALS['log']->debug('Performing pre_action');
+            $this->breadcrumbs['handleActionTasksHistory'] .= $function. ' ';
+            $GLOBALS['log']->debug('Performing pre_action' . $function . ' MODULE: ' . $this->module);
             $this->$function();
 
             return true;
@@ -515,13 +530,14 @@ private function pre_action()
 
     /**
      * Perform the specified action.
-     * This can be overridde in a sub-class
+     * This can be overridden in a sub-class
      */
     private function do_action()
     {
         $function = $this->getActionMethodName();
         if ($this->hasFunction($function)) {
-            $GLOBALS['log']->debug('Performing action: ' . $function . ' MODULE: ' . $this->module);
+            $this->breadcrumbs['handleActionTasksHistory'] .= $function. ' ';
+            $GLOBALS['log']->debug('Performing do_action: ' . $function . ' MODULE: ' . $this->module);
             $this->$function();
 
             return true;
@@ -532,13 +548,14 @@ private function do_action()
 
     /**
      * Perform an action after to the specified action has occurred.
-     * This can be overridde in a sub-class
+     * This can be overridden in a sub-class
      */
     private function post_action()
     {
         $function = $this->getPostActionMethodName();
         if ($this->hasFunction($function)) {
-            $GLOBALS['log']->debug('Performing post_action');
+            $this->breadcrumbs['handleActionTasksHistory'] .= $function. ' ';
+            $GLOBALS['log']->debug('Performing post_action' . $function . ' MODULE: ' . $this->module);
             $this->$function();
 
             return true;
@@ -621,6 +638,7 @@ protected function set_redirect($url)
     protected function redirect()
     {
         if (!empty($this->redirect_url)) {
+            $this->breadcrumbs['processTasksHistory'] .= 'redirect…';
             SugarApplication::redirect($this->redirect_url);
         }
     }
@@ -1012,12 +1030,14 @@ private function blockFileAccess()
      */
     private function handleEntryPoint()
     {
+        $this->breadcrumbs['entryPointFile'] = '';
         if (!empty($_REQUEST['entryPoint'])) {
             $this->loadMapping('entry_point_registry');
             $entryPoint = $_REQUEST['entryPoint'];
 
             if (!empty($this->entry_point_registry[$entryPoint])) {
-                require_once($this->entry_point_registry[$entryPoint]['file']);
+                $this->breadcrumbs['entryPointFile'] = $this->entry_point_registry[$entryPoint]['file'];
+                require_once($this->breadcrumbs['entryPointFile']);
                 $this->_processed = true;
                 $this->view = '';
             }

include/SubPanel/SubPanelTiles.php

@@ -383,6 +383,9 @@ public function display($showContainer = true, $forceTabless = false)
 
         $tab_names = '["' . implode('","', $tab_names) . '"]';
 
+        if (!isset($module_sub_panels)) {
+            $module_sub_panels = [];
+        }
         $module_sub_panels = array_map('array_keys', $module_sub_panels);
         $module_sub_panels = json_encode($module_sub_panels);
 

include/SugarCache/SugarCacheRedis.php

@@ -152,7 +152,7 @@ protected function _clearExternal(
         $key
         ) {
         $key = $this->_fixKeyName($key);
-        $this->_getRedisObject()->delete($key);
+        $this->_getRedisObject()->del($key);
     }
 
     /**

include/SugarLogger/LoggerManager.php

@@ -81,6 +81,8 @@ class LoggerManager
         'debug' => 100,
         'info' => 70,
         'warn' => 50,
+        'PHP E' => 45,
+        'PHP S' => 44,
         'deprecated' => 40,
         'error' => 25,
         'fatal' => 10,
@@ -228,7 +230,7 @@ protected function _findAvailableLoggers()
                     }
                     require_once("$location/$file");
                     $loggerClass = basename($file, '.php');
-                    if (class_exists($loggerClass) && class_implements($loggerClass, 'LoggerTemplate')) {
+                        if (class_exists($loggerClass) && in_array('LoggerTemplate', class_implements($loggerClass))) {
                         self::$_loggers[$loggerClass] = new $loggerClass();
                     }
                 }