Skip to content

Update the code to not use trigger error or error log in production #208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DenisFlorin wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update the code to not use trigger error or error log in production #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions gitium/functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@
* @package Gitium
*/

function gitium_error_log( $message ) {
if ( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) { return; }
error_log( "gitium_error_log: $message" );
}

function wp_content_is_versioned() {
return file_exists( WP_CONTENT_DIR . '/.git' );
}
Expand Down Expand Up @@ -234,38 +229,39 @@ function gitium_acquire_merge_lock() {
return false; // timeout
}
}
gitium_error_log( __FUNCTION__ );
return array( $gitium_lock_path, $gitium_lock_handle );
}
endif;

if ( ! function_exists( 'gitium_release_merge_lock' ) ) :
function gitium_release_merge_lock( $lock ) {
list( $gitium_lock_path, $gitium_lock_handle ) = $lock;
gitium_error_log( __FUNCTION__ );
flock( $gitium_lock_handle, LOCK_UN );
fclose( $gitium_lock_handle );
}
endif;

// Merges the commits with remote and pushes them back
function gitium_merge_and_push( $commits ) {
global $git;
global $git;
Copy link

@rstefan1 rstefan1 Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the indentation is inconsistent.


$lock = gitium_acquire_merge_lock()
or trigger_error( 'Timeout when gitium lock was acquired', E_USER_WARNING );
$lock = gitium_acquire_merge_lock();
if ( ! $lock ) {
wp_die( 'Gitium: failed to acquire merge lock. Please try again later.' );
}

if ( ! $git->fetch_ref() ) {
return false;
}
if ( ! $git->fetch_ref() ) {
return false;
}

$merge_status = $git->merge_with_accept_mine( $commits );
$merge_status = $git->merge_with_accept_mine( $commits );

gitium_release_merge_lock( $lock );
gitium_release_merge_lock( $lock );

return $git->push() && $merge_status;
return $git->push() && $merge_status;
}


function gitium_check_after_event( $plugin, $event = 'activation' ) {
global $git;

Expand Down
128 changes: 70 additions & 58 deletions gitium/gitium-webhook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,61 +21,73 @@
* @package Gitium
*/

header( 'Content-Type: text/html' );
define( 'SHORTINIT', true );

$current_dir = __DIR__;

// Define an array of possible WordPress root locations
$try_wp_roots = [
getenv('DOCUMENT_ROOT'),
filter_input(INPUT_SERVER, 'DOCUMENT_ROOT', FILTER_SANITIZE_FULL_SPECIAL_CHARS),
realpath($current_dir . '/../../../../../'),
realpath($current_dir . '/../../../../'),
realpath($current_dir . '/../../../'), // Typical WordPress structure
realpath($current_dir . '/../../'), // Alternative structure
realpath($current_dir . '/../'), // Closer parent directory
$current_dir, // Fallback to current directory
];

$wordpress_loader = null;

foreach ($try_wp_roots as $root) {
if ($root && file_exists($root . '/wp-load.php')) {
$wordpress_loader = $root . '/wp-load.php';
break;
}
}

if ($wordpress_loader) {
require_once $wordpress_loader;
} else {
die('Error: Unable to locate wp-load.php. Please verify your WordPress installation.');
}

require_once __DIR__ . '/functions.php';
require_once __DIR__ . '/inc/class-git-wrapper.php';

$webhook_key = get_option( 'gitium_webhook_key', '' );
$get_key = filter_input(INPUT_GET, 'key', FILTER_SANITIZE_FULL_SPECIAL_CHARS);
if ( ! empty ( $webhook_key ) && isset( $get_key ) && $webhook_key == $get_key ) :
( '1.7' <= substr( $git->get_version(), 0, 3 ) ) or wp_die( 'Gitium plugin require minimum `git version 1.7`!' );

list( $git_public_key, $git_private_key ) = gitium_get_keypair();
if ( ! $git_public_key || ! $git_private_key )
wp_die('Not ready.', 'Not ready.', array( 'response' => 403 ));
else
$git->set_key( $git_private_key );

$commits = array();
$commitmsg = sprintf( 'Merged changes from %s on %s', $_SERVER['SERVER_NAME'], date( 'm.d.Y' ) );

if ( $git->is_dirty() && $git->add() > 0 ) {
$commits[] = $git->commit( $commitmsg ) or trigger_error( 'Could not commit local changes!', E_USER_ERROR );
}
gitium_merge_and_push( $commits ) or trigger_error( 'Failed merge & push: ' . serialize( $git->get_last_error() ), E_USER_ERROR );

wp_die( $commitmsg , 'Pull done!', array( 'response' => 200 ) );
else :
wp_die( 'Cheating uh?', 'Cheating uh?', array( 'response' => 403 ) );
endif;
header( 'Content-Type: text/html' );
define( 'SHORTINIT', true );

$current_dir = __DIR__;

// Define possible WordPress root locations
$try_wp_roots = [
getenv( 'DOCUMENT_ROOT' ),
filter_input( INPUT_SERVER, 'DOCUMENT_ROOT', FILTER_SANITIZE_FULL_SPECIAL_CHARS ),
realpath( $current_dir . '/../../../../../' ),
realpath( $current_dir . '/../../../../' ),
realpath( $current_dir . '/../../../' ),
realpath( $current_dir . '/../../' ),
realpath( $current_dir . '/../' ),
$current_dir,
];

$wordpress_loader = null;
foreach ( $try_wp_roots as $root ) {
if ( $root && file_exists( $root . '/wp-load.php' ) ) {
$wordpress_loader = $root . '/wp-load.php';
break;
}
}

if ( $wordpress_loader ) {
require_once $wordpress_loader;
} else {
wp_die( 'Error: Unable to locate wp-load.php. Please verify your WordPress installation.', 'Gitium Error', [ 'response' => 500 ] );
}

require_once __DIR__ . '/functions.php';
require_once __DIR__ . '/inc/class-git-wrapper.php';

$webhook_key = get_option( 'gitium_webhook_key', '' );
$get_key = filter_input( INPUT_GET, 'key', FILTER_SANITIZE_FULL_SPECIAL_CHARS );

if ( empty( $webhook_key ) || $get_key !== $webhook_key ) {
wp_die( 'Cheating uh?', 'Gitium Error', [ 'response' => 403 ] );
}

if ( version_compare( $git->get_version(), '1.7', '<' ) ) {
wp_die( 'Gitium plugin requires minimum git version 1.7.', 'Gitium Error', [ 'response' => 500 ] );
}

// Load keypair
list( $git_public_key, $git_private_key ) = gitium_get_keypair();
if ( ! $git_public_key || ! $git_private_key ) {
wp_die( 'Gitium is not ready. SSH keys are missing.', 'Gitium Error', [ 'response' => 403 ] );
}

$git->set_key( $git_private_key );

$commitmsg = sprintf( 'Merged changes from %s on %s', $_SERVER['SERVER_NAME'], date( 'm.d.Y' ) );
$commits = [];

if ( $git->is_dirty() && $git->add() > 0 ) {
$commit = $git->commit( $commitmsg );
if ( ! $commit ) {
wp_die( 'Error: Could not commit local changes.', 'Gitium Error', [ 'response' => 500 ] );
Copy link

@rstefan1 rstefan1 Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
wp_die( 'Error: Could not commit local changes.', 'Gitium Error', [ 'response' => 500 ] );
wp_die( 'Could not commit local changes.', 'Gitium Error', [ 'response' => 500 ] );

}
$commits[] = $commit;
}

if ( ! gitium_merge_and_push( $commits ) ) {
$error = $git->get_last_error();
wp_die( 'Error: Merge & push failed. ' . ( is_string( $error ) ? $error : '' ), 'Gitium Error', [ 'response' => 500 ] );
Copy link

@rstefan1 rstefan1 Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
wp_die( 'Error: Merge & push failed. ' . ( is_string( $error ) ? $error : '' ), 'Gitium Error', [ 'response' => 500 ] );
wp_die( 'Merge & push failed. ' . ( is_string( $error ) ? $error : '' ), 'Gitium Error', [ 'response' => 500 ] );

}

wp_die( esc_html( $commitmsg ), 'Pull done!', [ 'response' => 200 ] );
5 changes: 0 additions & 5 deletions gitium/gitium.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,6 @@ function gitium_upgrader_post_install( $res, $hook_extra, $result ) {
}
}

if ( WP_DEBUG ) {
error_log( __FUNCTION__ . ':hook_extra:' . serialize( $hook_extra ) );
error_log( __FUNCTION__ . ':action:type:' . $action . ':' . $type );
}

$git_dir = $result['destination'];
$version = '';

Expand Down
24 changes: 3 additions & 21 deletions gitium/inc/class-git-wrapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,6 @@ function _rrmdir( $dir ) {
return rmdir( $dir );
}

function _log(...$args) {
if ( ! defined( 'WP_DEBUG' ) || ! WP_DEBUG ) { return; }

$output = '';
if (isset($args) && $args) foreach ( $args as $arg ) {
$output .= var_export($arg, true).'/n/n';
}

if ($output) error_log($output);
}

function _git_temp_key_file() {
$key_file = tempnam( sys_get_temp_dir(), 'ssh-git' );
return $key_file;
Expand Down Expand Up @@ -190,7 +179,6 @@ protected function _call(...$args) {
}
$return = (int)proc_close( $proc );
}
$this->_log( "$return $cmd", join( "\n", $response ) );
if ( ! defined( 'GIT_KEY_FILE' ) && isset( $env['GIT_KEY_FILE'] ) ) {
unlink( $env['GIT_KEY_FILE'] );
}
Expand Down Expand Up @@ -259,16 +247,11 @@ function is_dot_git_dir( $dir ) {
function cleanup() {
$dot_git_dir = realpath( $this->repo_dir . '/.git' );
if ( $this->is_dot_git_dir( $dot_git_dir ) && $this->_rrmdir( $dot_git_dir ) ) {
if ( WP_DEBUG ) {
error_log( "Gitium cleanup successfull. Removed '$dot_git_dir'." );
}
return True;
}
if ( WP_DEBUG ) {
error_log( "Gitium cleanup failed. '$dot_git_dir' is not a .git dir." );
return true;
}
return False;
return false; // Failure silently handled.
}


function add_remote_url( $url ) {
list( $return, ) = $this->_call( 'remote', 'add', 'origin', $url );
Expand Down Expand Up @@ -311,7 +294,6 @@ function fetch_ref() {

protected function _resolve_merge_conflicts( $message ) {
list( , $changes ) = $this->status( true );
$this->_log( $changes );
foreach ( $changes as $path => $change ) {
if ( in_array( $change, array( 'UD', 'DD' ) ) ) {
$this->_call( 'rm', $path );
Expand Down