├── .gitignore
├── README.md
├── composer.json
├── modman
└── src
    └── app
        ├── code
            └── community
            │   └── EmPeWe
            │       └── ApiLogger
            │           ├── Helper
            │               ├── Data.php
            │               ├── V1.php
            │               └── V2.php
            │           ├── Model
            │               └── Server
            │               │   ├── Handler.php
            │               │   └── V2
            │               │       └── Handler.php
            │           └── etc
            │               ├── config.xml
            │               └── system.xml
        └── etc
            └── modules
                └── EmPeWe_ApiLogger.xml


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Magento SOAP API Logger
 2 | =======================
 3 | 
 4 | Facts
 5 | -----
 6 | - version: 0.0.8
 7 | - [extension on GitHub](https://github.com/EmPeWe/magento-api-logger)
 8 | 
 9 | Description
10 | -----------
11 | This Magento extensions allow the API calls to be logged. At the moment only SOAP API v1/v2 could be logged.
12 | 
13 | Requirements
14 | ------------
15 | - PHP >= 5.2.0
16 | - Mage_Core
17 | 
18 | Compatibility
19 | -------------
20 | - Tested on Magento CE 1.8.1.0 - 1.9.1 and EE 1.13.1 - 1.14.1, but should work with older versions too
21 | 
22 | Installation Instructions
23 | -------------------------
24 | 1. Install/Deploy the extension via modman or copy all the files into your document root.
25 | 2. Clear the cache, logout from the admin panel and then login again.
26 | 3. Configure and activate the extension under System - Configuration - EMPEWE - SOAP ApiLogger.
27 | 
28 | Hints
29 | -----
30 | 1. ~~The logger will only work, if the global log settings (System -> Configuration -> Developer -> Log Settings) are active.~~
31 | 2. If you installed the extensions with modman, don't forget to allow Symlinks (System -> Configuration -> Developer -> Template Settings)
32 | 
33 | Uninstallation
34 | --------------
35 | 1. Remove all extension files from your Magento installation
36 | 2. Delete all entry from core_config_data with path starting like 'apilogger_options/config/%'
37 | 
38 | Support
39 | -------
40 | If you have any issues with this extension, open an issue on [GitHub](https://github.com/EmPeWe/magento-api-logger/issues).
41 | 
42 | Contribution
43 | ------------
44 | Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).
45 | 
46 | Copyright
47 | ---------
48 | (c) 2014-2016 EmPeWe
49 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "empewe/magento-api-logger",
 3 |     "license": "Beerware",
 4 |     "type": "magento-module",
 5 |     "description": "Magento extensions to log SOAP API calls",
 6 |     "keywords":
 7 |     [
 8 |         "magento",
 9 |         "api",
10 |         "logging",
11 |         "events"
12 |     ],
13 |     "homepage": "https://github.com/EmPeWe/magento-api-logger",
14 |     "require":
15 |     {
16 |         "php": ">5.2",
17 |         "magento-hackathon/magento-composer-installer": "*"
18 |     },
19 |     "authors":
20 |     [
21 |         {
22 |             "name": "Manuel Weinstein",
23 |             "homepage": "https://github.com/EmPeWe",
24 |             "role": "Developer"
25 |         }
26 |     ],
27 |     "support":
28 |     {
29 |         "source": "https://github.com/EmPeWe/magento-api-logger",
30 |         "issues": "https://github.com/EmPeWe/magento-api-logger/issues"
31 |     }
32 | }
33 | 


--------------------------------------------------------------------------------
/modman:
--------------------------------------------------------------------------------
1 | src/app/code/community/EmPeWe/ApiLogger     app/code/community/EmPeWe/ApiLogger
2 | src/app/etc/modules/*    app/etc/modules/


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/Helper/Data.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | class EmPeWe_ApiLogger_Helper_Data extends Mage_Core_Helper_Abstract
4 | {
5 | 
6 | }
7 | 


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/Helper/V1.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | class EmPeWe_ApiLogger_Helper_V1 extends Mage_Core_Helper_Abstract
  4 | {
  5 |     /**
  6 |      * @param mixed $store
  7 |      * @return bool
  8 |      */
  9 |     public function getIsActive($store = null)
 10 |     {
 11 |         return Mage::getStoreConfigFlag('apilogger_options/config/apilogger_v1_log_active', $store);
 12 |     }
 13 | 
 14 |     /**
 15 |      * @param mixed $store
 16 |      * @return bool
 17 |      */
 18 |     public function getIsVerboseEnabled($store = null)
 19 |     {
 20 |         return Mage::getStoreConfigFlag('apilogger_options/config/apilogger_v1_log_verbose', $store);
 21 |     }
 22 | 
 23 |     /**
 24 |      * @param mixed $store
 25 |      * @return string
 26 |      */
 27 |     public function getLogFilename($store = null)
 28 |     {
 29 |         return (string)Mage::getStoreConfig('apilogger_options/config/apilogger_v1_log_file', $store);
 30 |     }
 31 | 
 32 |     /**
 33 |      * @param mixed $store
 34 |      * @return bool
 35 |      */
 36 |     public function getForceLog($store = null)
 37 |     {
 38 |         return Mage::getStoreConfigFlag('apilogger_options/config/apilogger_force_log', $store);
 39 |     }
 40 | 
 41 |     public function log(
 42 |         $requestId,
 43 |         $sessionId,
 44 |         $apiPath,
 45 |         $args = array(),
 46 |         $response = null,
 47 |         Exception $exception = null
 48 |     ) {
 49 |         if (!$this->getIsActive() || ($response === null && !$this->getIsVerboseEnabled())) {
 50 |             return;
 51 |         }
 52 | 
 53 |         $log = "SOAP Method (V1): {$apiPath}";
 54 | 
 55 |         $log .= "\nRequest ID: {$requestId}";
 56 | 
 57 |         $apiUser = $this->getSession()->getUser();
 58 |         if ($apiUser instanceof Mage_Api_Model_User) {
 59 |             $log .= sprintf("\nAPI User: %s (ID: %s)", $apiUser->getUsername(), $apiUser->getId());
 60 |         }
 61 | 
 62 |         $log .= "\nCalled from IP: {$this->getRemoteAddr()}";
 63 |         $log .= "\nUser Agent: {$this->getHttpUserAgent()}";
 64 |         $log .= "\nParameters: " . print_r(array_merge((array)$sessionId, $args), true);
 65 | 
 66 |         if ($this->getIsVerboseEnabled()) {
 67 |             $log .= "\nResponse: " . print_r($response, true);
 68 |         }
 69 | 
 70 |         if ($exception) {
 71 |             $log .= "\nException: {$exception}";
 72 |         }
 73 | 
 74 |         $logLevel = ($exception ? Zend_Log::WARN : Zend_Log::DEBUG);
 75 | 
 76 |         Mage::log($log, $logLevel, $this->getLogFilename(), $this->getForceLog());
 77 |     }
 78 | 
 79 |     /**
 80 |      * @return string
 81 |      */
 82 |     protected function getRemoteAddr()
 83 |     {
 84 |         return Mage::helper('core/http')->getRemoteAddr();
 85 |     }
 86 | 
 87 |     /**
 88 |      * @return string
 89 |      */
 90 |     protected function getHttpUserAgent()
 91 |     {
 92 |         return Mage::helper('core/http')->getHttpUserAgent();
 93 |     }
 94 | 
 95 |     /**
 96 |      * Retrieve webservice session
 97 |      *
 98 |      * @return Mage_Api_Model_Session
 99 |      */
100 |     protected function getSession()
101 |     {
102 |         return Mage::getSingleton('api/session');
103 |     }
104 | }
105 | 


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/Helper/V2.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class EmPeWe_ApiLogger_Helper_V2 extends Mage_Core_Helper_Abstract
 4 | {
 5 |     /**
 6 |      * @param mixed $store
 7 |      * @return bool
 8 |      */
 9 |     public function getIsActive($store = null)
10 |     {
11 |         return Mage::getStoreConfigFlag('apilogger_options/config/apilogger_v2_log_active', $store);
12 |     }
13 | 
14 |     /**
15 |      * @param mixed $store
16 |      * @return bool
17 |      */
18 |     public function getIsVerboseEnabled($store = null)
19 |     {
20 |         return Mage::getStoreConfigFlag('apilogger_options/config/apilogger_v2_log_verbose', $store);
21 |     }
22 | 
23 |     /**
24 |      * @param mixed $store
25 |      * @return string
26 |      */
27 |     public function getLogFilename($store = null)
28 |     {
29 |         return (string)Mage::getStoreConfig('apilogger_options/config/apilogger_v2_log_file', $store);
30 |     }
31 | 
32 |     /**
33 |      * @param mixed $store
34 |      * @return bool
35 |      */
36 |     public function getForceLog($store = null)
37 |     {
38 |         return Mage::getStoreConfigFlag('apilogger_options/config/apilogger_force_log', $store);
39 |     }
40 | 
41 |     public function log($requestId, $function, $args = array(), $response = null, Exception $exception = null)
42 |     {
43 |         if (!$this->getIsActive() || ($response === null && !$this->getIsVerboseEnabled())) {
44 |             return;
45 |         }
46 | 
47 |         $log = "SOAP Method (V2): {$function}";
48 | 
49 |         $log .= "\nRequest ID: {$requestId}";
50 | 
51 |         $apiUser = $this->getSession()->getUser();
52 |         if ($apiUser instanceof Mage_Api_Model_User) {
53 |             $log .= sprintf("\nAPI User: %s (ID: %s)", $apiUser->getUsername(), $apiUser->getId());
54 |         }
55 | 
56 |         $log .= "\nCalled from IP: {$this->getRemoteAddr()}";
57 |         $log .= "\nUser Agent: {$this->getHttpUserAgent()}";
58 |         $log .= "\nParameters: " . print_r($args, true);
59 | 
60 |         if ($this->getIsVerboseEnabled()) {
61 |             $log .= "\nResponse: " . print_r($response, true);
62 |         }
63 | 
64 |         if ($exception) {
65 |             $log .= "\nException: {$exception}";
66 |         }
67 | 
68 |         $logLevel = ($exception ? Zend_Log::WARN : Zend_Log::DEBUG);
69 | 
70 |         Mage::log($log, $logLevel, $this->getLogFilename(), $this->getForceLog());
71 |     }
72 | 
73 |     /**
74 |      * @return string
75 |      */
76 |     protected function getRemoteAddr()
77 |     {
78 |         return Mage::helper('core/http')->getRemoteAddr();
79 |     }
80 | 
81 |     /**
82 |      * @return string
83 |      */
84 |     protected function getHttpUserAgent()
85 |     {
86 |         return Mage::helper('core/http')->getHttpUserAgent();
87 |     }
88 | 
89 |     /**
90 |      * Retrieve webservice session
91 |      *
92 |      * @return Mage_Api_Model_Session
93 |      */
94 |     protected function getSession()
95 |     {
96 |         return Mage::getSingleton('api/session');
97 |     }
98 | }
99 | 


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/Model/Server/Handler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class EmPeWe_ApiLogger_Model_Server_Handler extends Mage_Api_Model_Server_Handler
 4 | {
 5 |     public function call($sessionId, $apiPath, $args = array())
 6 |     {
 7 |         $requestId = $this->generateRequestId($sessionId);
 8 | 
 9 |         $helper = $this->getHelper();
10 | 
11 |         try {
12 |             $helper->log($requestId, $sessionId, $apiPath, $args);
13 | 
14 |             $response = parent::call($sessionId, $apiPath, $args);
15 | 
16 |             $helper->log($requestId, $sessionId, $apiPath, $args, $response);
17 | 
18 |             return $response;
19 |         } catch (Exception $e) {
20 |             $helper->log($requestId, $sessionId, $apiPath, $args, isset($response) ? $response : null, $e);
21 | 
22 |             throw $e;
23 |         }
24 |     }
25 | 
26 |     /**
27 |      * @return EmPeWe_ApiLogger_Helper_V1
28 |      */
29 |     protected function getHelper()
30 |     {
31 |         return Mage::helper('empewe_apilogger/v1');
32 |     }
33 | 
34 |     /**
35 |      * @param string $sessionId
36 |      * @return string
37 |      */
38 |     protected function generateRequestId($sessionId)
39 |     {
40 |         return uniqid($sessionId . '_', true);
41 |     }
42 | }
43 | 


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/Model/Server/V2/Handler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class EmPeWe_ApiLogger_Model_Server_V2_Handler extends Mage_Api_Model_Server_V2_Handler
 4 | {
 5 |     public function __call($function, $args = array())
 6 |     {
 7 |         list($sessionId) = $args;
 8 | 
 9 |         $requestId = $this->generateRequestId($sessionId);
10 | 
11 |         $helper = $this->getHelper();
12 | 
13 |         try {
14 |             $helper->log($requestId, $function, $args);
15 | 
16 |             $response = parent::__call($function, $args);
17 | 
18 |             $helper->log($requestId, $function, $args, $response);
19 | 
20 |             return $response;
21 |         } catch (Exception $e) {
22 |             $helper->log($requestId, $function, $args, isset($response) ? $response : null, $e);
23 | 
24 |             throw $e;
25 |         }
26 |     }
27 | 
28 |     /**
29 |      * @return EmPeWe_ApiLogger_Helper_V2
30 |      */
31 |     protected function getHelper()
32 |     {
33 |         return Mage::helper('empewe_apilogger/v2');
34 |     }
35 | 
36 |     /**
37 |      * @param string $sessionId
38 |      * @return string
39 |      */
40 |     protected function generateRequestId($sessionId)
41 |     {
42 |         return uniqid($sessionId . '_', true);
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/etc/config.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <config>
 3 |     <modules>
 4 |         <EmPeWe_ApiLogger>
 5 |             <version>0.0.8</version>
 6 |         </EmPeWe_ApiLogger>
 7 |     </modules>
 8 |     <global>
 9 |         <helpers>
10 |             <empewe_apilogger>
11 |                 <class>EmPeWe_ApiLogger_Helper</class>
12 |             </empewe_apilogger>
13 |         </helpers>
14 |         <models>
15 |             <empewe_apilogger>
16 |                 <class>EmPeWe_ApiLogger_Model</class>
17 |             </empewe_apilogger>
18 |             <api>
19 |                 <rewrite>
20 |                     <server_handler>EmPeWe_ApiLogger_Model_Server_Handler</server_handler>
21 |                     <server_v2_handler>EmPeWe_ApiLogger_Model_Server_V2_Handler</server_v2_handler>
22 |                 </rewrite>
23 |             </api>
24 |         </models>
25 |     </global>
26 |     <default>
27 |         <apilogger_options>
28 |             <config>
29 |                 <apilogger_v1_log_active>1</apilogger_v1_log_active>
30 |                 <apilogger_v1_log_file>EmPeWe_ApiLogger.log</apilogger_v1_log_file>
31 |                 <apilogger_v2_log_active>1</apilogger_v2_log_active>
32 |                 <apilogger_v2_log_file>EmPeWe_ApiLogger.log</apilogger_v2_log_file>
33 |             </config>
34 |         </apilogger_options>
35 |     </default>
36 |     <adminhtml>
37 |         <acl>
38 |             <resources>
39 |                 <all>
40 |                     <title>Allow Everything</title>
41 |                 </all>
42 |                 <admin>
43 |                     <children>
44 |                         <system>
45 |                             <children>
46 |                                 <config>
47 |                                     <children>
48 |                                         <apilogger_options>
49 |                                             <title>EmPeWe - All</title>
50 |                                         </apilogger_options>
51 |                                     </children>
52 |                                 </config>
53 |                             </children>
54 |                         </system>
55 |                     </children>
56 |                 </admin>
57 |             </resources>
58 |         </acl>
59 |     </adminhtml>
60 | </config>


--------------------------------------------------------------------------------
/src/app/code/community/EmPeWe/ApiLogger/etc/system.xml:
--------------------------------------------------------------------------------
  1 | <config>
  2 |     <tabs>
  3 |         <apilogger_config translate="label" module="empewe_apilogger">
  4 |             <label>EmPeWe</label>
  5 |             <sort_order>99999</sort_order>
  6 |         </apilogger_config>
  7 |     </tabs>
  8 |     <sections>
  9 |         <apilogger_options translate="label" module="empewe_apilogger">
 10 |             <label>SOAP ApiLogger</label>
 11 |             <tab>apilogger_config</tab>
 12 |             <frontend_type>text</frontend_type>
 13 |             <sort_order>1000</sort_order>
 14 |             <show_in_default>1</show_in_default>
 15 |             <show_in_website>1</show_in_website>
 16 |             <show_in_store>1</show_in_store>
 17 |             <groups>
 18 |                 <config translate="label">
 19 |                     <label>Options</label>
 20 |                     <frontend_type>text</frontend_type>
 21 |                     <sort_order>1</sort_order>
 22 |                     <show_in_default>1</show_in_default>
 23 |                     <show_in_website>1</show_in_website>
 24 |                     <show_in_store>1</show_in_store>
 25 |                     <fields>
 26 |                         <apilogger_v1_log_active translate="label">
 27 |                             <label>Activate Logging (v1):</label>
 28 |                             <comment>Don't forget to deactivate before going live!</comment>
 29 |                             <frontend_type>select</frontend_type>
 30 |                             <sort_order>10</sort_order>
 31 |                             <show_in_default>1</show_in_default>
 32 |                             <show_in_website>1</show_in_website>
 33 |                             <show_in_store>1</show_in_store>
 34 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 35 |                         </apilogger_v1_log_active>
 36 |                         <apilogger_v1_log_verbose translate="label">
 37 |                             <label>Verbose Logging (v1):</label>
 38 |                             <comment>Log response returned</comment>
 39 |                             <frontend_type>select</frontend_type>
 40 |                             <sort_order>20</sort_order>
 41 |                             <show_in_default>1</show_in_default>
 42 |                             <show_in_website>1</show_in_website>
 43 |                             <show_in_store>1</show_in_store>
 44 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 45 |                         </apilogger_v1_log_verbose>
 46 |                         <apilogger_v1_log_file translate="label">
 47 |                             <label>Log filename (v1):</label>
 48 |                             <comment>Default is EmPeWe_ApiLogger.log</comment>
 49 |                             <frontend_type>text</frontend_type>
 50 |                             <sort_order>30</sort_order>
 51 |                             <show_in_default>1</show_in_default>
 52 |                             <show_in_website>1</show_in_website>
 53 |                             <show_in_store>1</show_in_store>
 54 |                         </apilogger_v1_log_file>
 55 |                         <apilogger_v2_log_active translate="label">
 56 |                             <label>Activate Logging (v2):</label>
 57 |                             <comment>Don't forget to deactivate before going live!</comment>
 58 |                             <frontend_type>select</frontend_type>
 59 |                             <sort_order>40</sort_order>
 60 |                             <show_in_default>1</show_in_default>
 61 |                             <show_in_website>1</show_in_website>
 62 |                             <show_in_store>1</show_in_store>
 63 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 64 |                         </apilogger_v2_log_active>
 65 |                         <apilogger_v2_log_verbose translate="label">
 66 |                             <label>Verbose Logging (v2):</label>
 67 |                             <comment>Log response returned</comment>
 68 |                             <frontend_type>select</frontend_type>
 69 |                             <sort_order>50</sort_order>
 70 |                             <show_in_default>1</show_in_default>
 71 |                             <show_in_website>1</show_in_website>
 72 |                             <show_in_store>1</show_in_store>
 73 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 74 |                         </apilogger_v2_log_verbose>
 75 |                         <apilogger_v2_log_file translate="label">
 76 |                             <label>Log filename (v2):</label>
 77 |                             <comment>Default is EmPeWe_ApiLogger.log</comment>
 78 |                             <frontend_type>text</frontend_type>
 79 |                             <sort_order>60</sort_order>
 80 |                             <show_in_default>1</show_in_default>
 81 |                             <show_in_website>1</show_in_website>
 82 |                             <show_in_store>1</show_in_store>
 83 |                         </apilogger_v2_log_file>
 84 |                         <apilogger_force_log translate="label">
 85 |                             <label>Force Logging:</label>
 86 |                             <comment>Log even, if system logging is deactivated</comment>
 87 |                             <frontend_type>select</frontend_type>
 88 |                             <sort_order>70</sort_order>
 89 |                             <show_in_default>1</show_in_default>
 90 |                             <show_in_website>1</show_in_website>
 91 |                             <show_in_store>1</show_in_store>
 92 |                             <source_model>adminhtml/system_config_source_yesno</source_model>
 93 |                         </apilogger_force_log>
 94 |                     </fields>
 95 |                 </config>
 96 |             </groups>
 97 |         </apilogger_options>
 98 |     </sections>
 99 | </config>
100 | 


--------------------------------------------------------------------------------
/src/app/etc/modules/EmPeWe_ApiLogger.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <config>
 3 |     <modules>
 4 |         <EmPeWe_ApiLogger>
 5 |             <active>true</active>
 6 |             <codePool>community</codePool>
 7 |             <depends></depends>
 8 |         </EmPeWe_ApiLogger>
 9 |     </modules>
10 | </config>


--------------------------------------------------------------------------------