현재 이 홈페이지의 플랫폼으로 사용하고 있는 XE(XpressEngine, 예전 제로보드XE)는 다양한 기능을 가진 CMS이다. 현재 나와있는 모듈과 애드온, 위젯, 스킨 등을 적절히 조합해서 사용하기에도 좋고, 어느 CMS에서나 그렇겠지만, 자신이 원하는 기능이 있다면 직접 만들어서 쉽게 붙여 넣을 수도 있다.

이렇게 자신이 원하는 기능을 직접 만들다보면 디버깅을 해야 하는 경우가 있다. 아니, 항상 그럴 것이다. 한번에 뚝딱 하고 만들어내는 천재적인 재능이 있지 않다면 말이지.

이런 기존의 CMS 툴을 사용할 경우 디버깅을 한다는 것은 그리 간단한 일은 아니다. 특히 XE의 경우에는 모든 출력을 차근 차근 만들어 모아놓은 다음 모든 작업을 수행하고 마지막에 한꺼번에 출력하기 때문에, 중간에 사용자가 디버깅 등을 위해 출력을 하게 될 경우 예외 없이 에러 메시지를 만나게 될 것이다.

encoding_error.png


위 그림처럼 브라우저에서 오류를 보여주거나, 헤더 출력 오류 메시지가 나오게 될 것이다.

그렇다면 어떻게 디버깅을 하란 말인가? 답은 그리 어렵지 않다. 이미 XE에서는 훌륭한 디버깅 방법을 마련해두고 있다.


config/config.inc.php 파일을 보면 이에 대한 해답을 찾을 수 있다. 이 글에서는 현재 배포 버전인 XE 1.2.0 버전을 기준으로 이야기한다.

config/config.inc.php
    /**
     * @brief 기본 설정에 우선하는 사용자 설정 파일
     * config/config.user.inc.php 파일에 아래 내용을 저장하면 됨
     * <?php 
     * define('__DEBUG__', 0);
     * define('__DEBUG_OUTPUT__', 0);
     * define('__DEBUG_PROTECT__', 1);
     * define('__DEBUG_PROTECT_IP__', '127.0.0.1');
     * define('__DEBUG_DB_OUTPUT__', 0);
     * define('__LOG_SLOW_QUERY__', 0);
     * define('__OB_GZHANDLER_ENABLE__', 1);
     * ?>
     */
    if(file_exists(_XE_PATH_.'config/config.user.inc.php')) {
        require _XE_PATH_.'config/config.user.inc.php';
    }

위에서 보면 알겠지만, 사용자 설정 파일을 작성해 놓으면 이 설정을 기본 설정보다 우선해서 적용시키기 때문에 사용자 입맛에 맞게 디버깅을 할 수 있다.

이를 위해 우선 config/config.user.inc.php 파일을 만들어두자. 이 파일 이름은 config/config.inc.php 파일에서 기본으로 찾는 파일 이름이기 때문에 특별한 이유가 없다면 그대로 사용하는 것이 좋다.


이 파일의 내용은 config/config.inc.php 파일의 본문 내용에 나와있는 것처럼 자신의 설정에 맞도록 적어주면 된다.

config/config.user.inc.php
<?php

define('__DEBUG__', 1);
define('__DEBUG_OUTPUT__', 2);
define('__DEBUG_PROTECT__', 1);
define('__DEBUG_PROTECT_IP__', '123.123.123.123');
define('__DEBUG_DB_OUTPUT__', 0);
define('__LOG_SLOW_QUERY__', 0);
define('__OB_GZHANDLER_ENABLE__', 1);

?>


config/config.inc.php 파일을 보면 이미 나와있지만, 위 설정값을 하나씩 살펴보자면

__DEBUG__
기본값은 0 으로, 이것은 디버깅 메시지 출력을 할 것인지, 어떤 것을 할 것인지를 설정하는 지시자이다.
  • 0 : 디버그 메시지를 생성/ 출력하지 않음
  • 1 : debugPrint() 함수를 통한 메시지 출력
  • 2 : 소요시간, Request/Response info 출력
  • 4 : DB 쿼리 내역 출력
이 지시자의 설정값은 비트 OR 연산으로 값을 설정한다. 예를 들어, 모든 설정을 활성시키고자 한다면 7로 설정하면 된다.

__DEBUG_OUTPUT__
기본값은 0 으로, 이것은 디버그 메시지의 출력 방법에 대해 설정하는 지시자이다.
  • 0 : files/_debug_message.php 에 연결하여 출력
  • 1 : HTML 최하단에 주석으로 출력 (Response Method가 HTML 일 때)
  • 2 : Firebug 콘솔에 출력 (PHP >= 5.2.0. Firebug/FirePHP 플러그인 필요)
여기에서 아주 유용한 것이 Mozilla FirefoxFirebugFirePHP 애드온을 이용하는 방법인데, Firefox를 사용한다면 이 두 애드온을 설치해서 이 방법을 이용하는 것이 여러 모로 편리할 것이다.

__DEBUG_OUTPUT__ 의 값을 2 로 설정하고, Firebug와 FirePHP 애드온을 설치한 후 활성시키면, XE 디버깅을 위한 준비는 끝나게 된다.

firephp_enabled.png


__DEBUG_PROTECT__
기본값은 1 이고, 이것은 __DEBUG_OUTPUT__ 지시자의 설정값을 1 혹은 2로 했을 때, 즉 디버그 메시지를 HTML의 주석으로 보거나 FirePHP 콘솔를 통해 볼 수 있도록 설정했을 때 특정 IP 주소에서 접속했을 때만 보여줄 것인가를 설정하는 것이다.
  • 0 : 제한 없음 (권장하지 않음)
  • 1 : 지정한 IP 주소에만 허용
가급적 1 로 설정하는 것이 좋을 것이다. 그렇지 않은 경우 이로 인해 발생할 수도 있는 문제는 심각해질 수도 있다.

__DEBUG_PROTECT_IP__
기본값은 127.0.0.1 이고, 이 지시자는 __DEBUG_PROTECT__ 지시자의 값을 1로 설정했을 때 디버그 메시지 출력을 허용할 IP 주소를 설정하는 것이다. 여기에는 자신의 IP 주소를 설정해주면 된다.


이제 모든 준비가 끝났다. 설정이 제대로 되었다면 아래 그림과 같이 디버그 메시지가 나올 것이다. 이제 Firebug와 FirePHP 애드온를 통해 브라우저 상에서 손쉽게 디버그 메시지를 확인할 수 있다.

firephp_message2.png

당연한 이야기이지만, 디버그 메시지 출력을 위해서는 원하는 곳에서 debugPrint() 함수를 호출해줘야 한다.

addons/add_content.addon.php
    require_once($addon_path .'add_content.lib.php');

    $output = preg_replace_callback($pos_regx, getAddContent, $output);
    debugPrint("Hi, there!!");
    debugPrint("called_position = $called_position");


참~ 쉽지요!