Skip to content

Commit

Permalink
feat(agent): add support for CakePHP 4.x and 5.x (#983)
Browse files Browse the repository at this point in the history 
This PR does the following:

- Modifies how the action name is retrieved, so that it is compatible
with CakePHP 4.x and 5.x
- Adds correct detection file for CakePHP 4.x and 5.x
- Adds call to `nr_txn_suggest_package_supportability_metric` in
`nr_cakephp_enable`

---------

Co-authored-by: Michal Nowacki <[email protected]>
  • Loading branch information
@hahuja2 @lavarou
hahuja2 and lavarou authored Nov 22, 2024
1 parent 467f79e commit bae6375
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 238 deletions.
282 changes: 62 additions & 220 deletions agent/fw_cakephp.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*/

#include "php_agent.h"
#include "php_error.h"
#include "php_execute.h"
#include "php_user_instrument.h"
#include "php_wrapper.h"
Expand All @@ -12,132 +13,14 @@
#include "util_logging.h"
#include "util_memory.h"

nr_framework_classification_t nr_cakephp_special_1(
const char* filename TSRMLS_DC) {
NR_UNUSED_TSRMLS;

if (nr_strcaseidx(filename, "cake/libs/object.php") >= 0) {
return FRAMEWORK_IS_SPECIAL;
}

return FRAMEWORK_IS_NORMAL;
}

nr_framework_classification_t nr_cakephp_special_2(
const char* filename TSRMLS_DC) {
NR_UNUSED_TSRMLS;

if (nr_strcaseidx(filename, "cake/core/app.php") >= 0) {
return FRAMEWORK_IS_SPECIAL;
}

return FRAMEWORK_IS_NORMAL;
}

/*
* For CakePHP 1.2 and 1.3 (and possibly earlier versions too) we hook into
* Component::initialize(). This function takes a controller as a parameter
* and we look into the params array of that controller object, and pick up
* the controller and action out of that array.
*
* CakePHP 1.x is end-of-life and no longer supported by the agent.
* Cake PHP 1.x does not support PHP 8+ and this wrapper is not updated for OAPI
* compatibility.
*
*/
NR_PHP_WRAPPER(nr_cakephp_name_the_wt_pre20) {
zval* arg1 = 0;
zval* params;
zval* czval;
zval* azval;
char* controller = 0;
char* action = 0;
int clen = 0;
int alen = 0;
char* name;

(void)wraprec;
NR_UNUSED_SPECIALFN;

NR_PHP_WRAPPER_REQUIRE_FRAMEWORK(NR_FW_CAKEPHP);

arg1 = nr_php_arg_get(1, NR_EXECUTE_ORIG_ARGS TSRMLS_CC);
if (!nr_php_is_zval_valid_object(arg1)) {
NR_PHP_WRAPPER_CALL;
goto end;
}

NR_PHP_WRAPPER_CALL;

params = nr_php_get_zval_object_property(arg1, "params" TSRMLS_CC);
if (0 == params) {
nrl_verbosedebug(NRL_FRAMEWORK, "CakePHP: no params found in component");
goto end;
}

if (IS_ARRAY != Z_TYPE_P(params)) {
nrl_verbosedebug(NRL_FRAMEWORK,
"CakePHP: component params is not an array");
goto end;
}

czval = nr_php_get_zval_object_property(params, "controller" TSRMLS_CC);
if (0 == czval) {
nrl_verbosedebug(NRL_FRAMEWORK,
"CakePHP: no params['controller'] in component");
} else {
clen = Z_STRLEN_P(czval);
controller = (char*)nr_alloca(clen + 1);
nr_strxcpy(controller, Z_STRVAL_P(czval), clen);
}

azval = nr_php_get_zval_object_property(params, "action" TSRMLS_CC);
if (0 == azval) {
nrl_verbosedebug(NRL_FRAMEWORK,
"CakePHP: no params['action'] in component");
} else {
alen = Z_STRLEN_P(azval);
action = (char*)nr_alloca(alen + 1);
nr_strxcpy(action, Z_STRVAL_P(azval), alen);
}

if ((0 == clen) && (0 == alen)) {
nrl_verbosedebug(NRL_FRAMEWORK,
"CakePHP: nothing to call the transaction (yet?)");
goto end;
}

name = (char*)nr_alloca(alen + clen + 2);
if (clen) {
nr_strcpy(name, controller);
}
if (alen) {
if (clen) {
nr_strcat(name, "/");
nr_strcat(name, action);
} else {
nr_strcpy(name, action);
}
}

nr_txn_set_path("CakePHP", NRPRG(txn), name, NR_PATH_TYPE_ACTION,
NR_NOT_OK_TO_OVERWRITE);

end:
nr_php_arg_release(&arg1);
}
NR_PHP_WRAPPER_END
#define PHP_PACKAGE_NAME "cakephp/cakephp"

/*
* For CakePHP 2.0 and on, we do things a little differently as the params
* array doesn't exist in the component any more. Instead we hook the
* Controller's invokeAction method. This gets the request as a parameter
* and we get the action from the params array in that object. The
* controller object ($this) has a name, and that name is used (along
* with the word "Controller" appended which is what the CakePHP code does).
*
* CakePHP 2.x is end-of-life and in maintenance mode (critical bugfixes only).
* As such, functionality added in PHP 7.1+ is not well supported.
* For CakePHP 4.0 and on, we retrieve the current controller object
* and are able to extract the controller name from that. We then
* retrieve the request object from the controller and are able to
* extract the action name from that. We then concatenate the two
* strings to form the transaction name.
*
* txn naming scheme:
* In this case, `nr_txn_set_path` is called after `NR_PHP_WRAPPER_CALL` with
Expand All @@ -147,17 +30,17 @@ NR_PHP_WRAPPER_END
* default way of calling the wrapped function in func_end.
*
*/
NR_PHP_WRAPPER(nr_cakephp_name_the_wt_2) {
zval* arg1 = 0;
NR_PHP_WRAPPER(nr_cakephp_name_the_wt_4) {
zval* this_var = 0;
zval* czval = 0;
char* controller = 0;
char* action = 0;
int clen = 0;
int alen = 0;
char* name = 0;
zval* params;
zval* azval;
zval* action_zval = NULL;
zval* request = NULL;
zval action_param;

(void)wraprec;
NR_UNUSED_SPECIALFN;
Expand Down Expand Up @@ -193,37 +76,24 @@ NR_PHP_WRAPPER(nr_cakephp_name_the_wt_2) {
}
}

arg1 = nr_php_arg_get(1, NR_EXECUTE_ORIG_ARGS TSRMLS_CC);
if (!nr_php_is_zval_valid_object(arg1)) {
NR_PHP_WRAPPER_CALL;
goto end;
}

NR_PHP_WRAPPER_CALL;

params = nr_php_get_zval_object_property(arg1, "params" TSRMLS_CC);
if (0 == params) {
nrl_verbosedebug(NRL_FRAMEWORK, "CakePHP: no params found in request");
request = nr_php_call(this_var, "getRequest");
if (!nr_php_is_zval_valid_object(request)) {
nrl_verbosedebug(NRL_FRAMEWORK, "CakePHP: no request found in controller");
goto end;
}

if (IS_ARRAY != Z_TYPE_P(params)) {
nrl_verbosedebug(NRL_FRAMEWORK, "CakePHP: request params is not an array");
nr_php_zval_str(&action_param, "action");
action_zval = nr_php_call(request, "getParam", &action_param);
zval_dtor(&action_param);
if (!nr_php_is_zval_non_empty_string(action_zval)) {
nrl_verbosedebug(NRL_FRAMEWORK, "CakePHP: no action param found in request");
goto end;
}

azval = nr_php_get_zval_object_property(params, "action" TSRMLS_CC);
if (0 == azval) {
nrl_verbosedebug(NRL_FRAMEWORK, "CakePHP: no params['action'] in request");
} else {
if (!nr_php_is_zval_valid_string(azval)) {
nrl_verbosedebug(NRL_FRAMEWORK,
"CakePHP: no string-valued params['action'] in request");
} else {
alen = Z_STRLEN_P(azval);
action = (char*)nr_alloca(alen + 1);
nr_strxcpy(action, Z_STRVAL_P(azval), alen);
}
alen = Z_STRLEN_P(action_zval);
action = (char*)nr_alloca(alen + 1);
nr_strxcpy(action, Z_STRVAL_P(action_zval), alen);
}

if ((0 == clen) && (0 == alen)) {
Expand All @@ -249,92 +119,64 @@ NR_PHP_WRAPPER(nr_cakephp_name_the_wt_2) {
NR_NOT_OK_TO_OVERWRITE);

end:
nr_php_arg_release(&arg1);
nr_php_scope_release(&this_var);
nr_php_zval_free(&request);
nr_php_zval_free(&action_zval);
}
NR_PHP_WRAPPER_END

/*
* CakePHP 1.2, 1.3
*
* Dispatch::cakeError will be called if there is a problem during dispatch
* (action or controller not found).
*
* CakePHP 1.x is end-of-life and no longer supported by the agent.
* Cake PHP 1.x does not support PHP 8+ and this wrapper is not updated for OAPI
* compatibility.
* CakePHP 4.0+
*
* Report errors and exceptions caught by CakePHP's error handler.
*/
NR_PHP_WRAPPER(nr_cakephp_problem_1) {
const char* name = "Dispatcher::cakeError";
NR_PHP_WRAPPER(nr_cakephp_error_handler_wrapper) {
zval* exception = NULL;
char* request_uri = nr_php_get_server_global("REQUEST_URI");

(void)wraprec;
NR_UNUSED_SPECIALFN;
(void)wraprec;

NR_PHP_WRAPPER_REQUIRE_FRAMEWORK(NR_FW_CAKEPHP);

nr_txn_set_path("CakePHP", NRPRG(txn), name, NR_PATH_TYPE_ACTION,
NR_NOT_OK_TO_OVERWRITE);

NR_PHP_WRAPPER_CALL;
}
NR_PHP_WRAPPER_END

/*
* CakePHP 2.0+
*
* If the action or controller is not found during the dispatch process, the
* appropriate Exception will be created and thrown. We wrap the CakeException
* constructor instead of the Exception handler, since CakePHP allows for the
* handler to be completely replaced.
*
* CakePHP 2.x is end-of-life and in maintenance mode (critical bugfixes only).
* As such, functionality added in PHP 7.1+ is not well supported.
*
* txn naming scheme:
* In this case, `nr_txn_set_path` is called before `NR_PHP_WRAPPER_CALL` with
* `NR_NOT_OK_TO_OVERWRITE` and as this corresponds to calling the wrapped
* function in func_begin it needs to be explicitly set as a before_callback to
* ensure OAPI compatibility. This entails that the first wrapped call gets to
* name the txn.
*/
NR_PHP_WRAPPER(nr_cakephp_problem_2) {
const char* name = "Exception";

(void)wraprec;
NR_UNUSED_SPECIALFN;
exception = nr_php_arg_get(1, NR_EXECUTE_ORIG_ARGS);
if (!nr_php_is_zval_valid_object(exception)) {
nrl_verbosedebug(NRL_FRAMEWORK, "%s: exception is NULL or not an object",
__func__);
goto end;
}

NR_PHP_WRAPPER_REQUIRE_FRAMEWORK(NR_FW_CAKEPHP);
if (NR_SUCCESS
!= nr_php_error_record_exception(
NRPRG(txn), exception, nr_php_error_get_priority(E_ERROR), true,
"Uncaught exception ", &NRPRG(exception_filters))) {
nrl_verbosedebug(NRL_FRAMEWORK, "%s: unable to record exception", __func__);
}

nr_txn_set_path("CakePHP", NRPRG(txn), name, NR_PATH_TYPE_ACTION,
NR_NOT_OK_TO_OVERWRITE);
if (NULL != request_uri) {
nr_txn_set_path("CakePHP Exception", NRPRG(txn), request_uri, NR_PATH_TYPE_URI,
NR_OK_TO_OVERWRITE);
} else {
nrl_verbosedebug(NRL_FRAMEWORK, "%s: request uri is NULL", __func__);
}

NR_PHP_WRAPPER_CALL;
end:
nr_php_arg_release(&exception);
nr_free(request_uri);
}
NR_PHP_WRAPPER_END

/*
* Enable CakePHP 1.2, 1.3
*/
void nr_cakephp_enable_1(TSRMLS_D) {
nr_php_wrap_user_function(NR_PSTR("Component::initialize"),
nr_cakephp_name_the_wt_pre20 TSRMLS_CC);
nr_php_wrap_user_function(NR_PSTR("Dispatcher::cakeError"),
nr_cakephp_problem_1 TSRMLS_CC);
}

/*
* Enable CakePHP 2.0+
* Enable CakePHP 4.0+
*/
void nr_cakephp_enable_2(TSRMLS_D) {
nr_php_wrap_user_function(NR_PSTR("Controller::invokeAction"),
nr_cakephp_name_the_wt_2 TSRMLS_CC);
#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
nr_php_wrap_user_function_before_after_clean(
NR_PSTR("CakeException::__construct"), nr_cakephp_problem_2, NULL, NULL);
#else
nr_php_wrap_user_function(NR_PSTR("CakeException::__construct"),
nr_cakephp_problem_2 TSRMLS_CC);
#endif
void nr_cakephp_enable(TSRMLS_D) {
nr_php_wrap_user_function(
NR_PSTR("Cake\\Controller\\Controller::invokeAction"),
nr_cakephp_name_the_wt_4);
nr_php_wrap_user_function(
NR_PSTR(
"Cake\\Error\\Middleware\\ErrorHandlerMiddleware::handleException"),
nr_cakephp_error_handler_wrapper);
nr_txn_suggest_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
PHP_PACKAGE_VERSION_UNKNOWN);
}
8 changes: 1 addition & 7 deletions agent/fw_hooks.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,7 @@
*/
#include "php_execute.h"

extern void nr_cakephp_enable_1(TSRMLS_D);
extern void nr_cakephp_enable_2(TSRMLS_D);
extern nr_framework_classification_t nr_cakephp_special_1(
const char* filename TSRMLS_DC);
extern nr_framework_classification_t nr_cakephp_special_2(
const char* filename TSRMLS_DC);

extern void nr_cakephp_enable(TSRMLS_D);
extern void nr_codeigniter_enable(TSRMLS_D);

extern int nr_drupal_is_framework(nrframework_t fw);
Expand Down
13 changes: 2 additions & 11 deletions agent/php_execute.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,15 +331,8 @@ typedef struct _nr_framework_table_t {
*/
// clang-format: off
static const nr_framework_table_t all_frameworks[] = {
/*
* Watch out:
* cake1.2 and cake1.3 use a subdirectory named 'cake' (lower case)
* cake2.0 and on use a subdirectory named 'Cake' (upper case file name)
*/
{"CakePHP", "cakephp", NR_PSTR("cake/libs/object.php"), nr_cakephp_special_1,
nr_cakephp_enable_1, NR_FW_CAKEPHP},
{"CakePHP", "cakephp", NR_PSTR("cake/core/app.php"), nr_cakephp_special_2,
nr_cakephp_enable_2, NR_FW_CAKEPHP},
{"CakePHP", "cakephp", NR_PSTR("cakephp/src/core/functions.php"), 0,
nr_cakephp_enable, NR_FW_CAKEPHP},

/*
* Watch out: frameworks or CMS' build on top of CodeIgniter might not get
Expand Down Expand Up @@ -522,8 +515,6 @@ static nr_library_table_t libraries[] = {
* with other frameworks or even without a framework at all.
*/
{"Laminas_Http", NR_PSTR("laminas-http/src/client.php"), nr_laminas_http_enable},

{"CakePHP3", NR_PSTR("cakephp/src/core/functions.php"), NULL},
};
// clang-format: on

Expand Down

0 comments on commit bae6375

Please sign in to comment.