Skip to content
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

Jump to bottom

System Logs v2 #2424

Merged
merged 12 commits into from
May 1, 2017
Merged

System Logs v2 #2424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8111cfb
removed sLogFile setting and updated debug to false by default
DawoudIO Apr 29, 2017
8ab1093
$logger is now alway set
DawoudIO Apr 29, 2017
12201e1
new dir for logs but no access from the web
DawoudIO Apr 29, 2017
5372926
Split logs into 3
DawoudIO Apr 29, 2017
9897474
always log PHP and APP Logs
DawoudIO Apr 29, 2017
f027179
NullHandler is no longer used
DawoudIO Apr 29, 2017
d46efa6
fixed typo
DawoudIO Apr 29, 2017
886124c
added "sLogLevel" from #2278
DawoudIO Apr 29, 2017
224af95
using logLevel to enable logs for ORM based on level
DawoudIO Apr 30, 2017
90e3e3d
fixed hint for Debug and sLogLevel
DawoudIO Apr 30, 2017
ba1bc19
removed debug and using sLogLevel
DawoudIO Apr 30, 2017
21ab3d6
Merge branch 'master' into 2.7.4-log-fixes
DawoudIO Apr 30, 2017
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,4 @@ src/ChurchCRM/model/ChurchCRM/Map
src/signatures.json
src/integrityCheck.json
src/tmp_attach
src/logs/*.log
21 changes: 18 additions & 3 deletions src/ChurchCRM/dto/SystemConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,26 @@ private static function getSupportedLocales()

}

public static function getMonoLogLevels()
{
return [
"Choices" => [
gettext("DEBUG").":100",
gettext("INFO").":200",
gettext("NOTICE").":250",
gettext("WARNING").":300",
gettext("ERROR").":400",
gettext("CRITICAL").":500",
gettext("ALERT").":550",
gettext("EMERGENCY").":600"
]
];
}

private static function buildConfigs()
{
return array(
"debug" => new ConfigItem(2, "debug", "boolean", "1", gettext("Set debug mode\r\nThis may be helpful for when you're first setting up ChurchCRM, but you should\r\nprobably turn it off for maximum security otherwise. If you are having trouble,\r\nplease enable this so that you'll know what the errors are. This is especially\r\nimportant if you need to report a problem on the help forums.")),
"sLogFile" => new ConfigItem(3, "sLogFile", "text", "/tmp/ChurchCRM.log", gettext("If debug is enabled the location of log files.")),
"sLogLevel" => new ConfigItem(4, "sLogLevel", "choice", "200", gettext("Event Log severity to write, used by ORM and App Logs"), json_encode(SystemConfig::getMonoLogLevels())),
"sDirClassifications" => new ConfigItem(5, "sDirClassifications", "text", "1,2,4,5", gettext("Include only these classifications in the directory, comma seperated")),
"sDirRoleHead" => new ConfigItem(6, "sDirRoleHead", "text", "1", gettext("These are the family role numbers designated as head of house")),
"sDirRoleSpouse" => new ConfigItem(7, "sDirRoleSpouse", "text", "2", gettext("These are the family role numbers designated as spouse")),
Expand Down Expand Up @@ -179,7 +194,7 @@ private static function buildCategories()
gettext('User setup') => ["sMinPasswordLength","sMinPasswordChange","iMaxFailedLogins","sSessionTimeout","sDisallowedPasswords"],
gettext('Email Setup') => ["sSMTPHost","sSMTPAuth","sSMTPUser","sSMTPPass", "iSMTPTimeout","sToEmailAddress","mailChimpApiKey"],
gettext('Member Setup') => ["sDirClassifications","sDirRoleHead","sDirRoleSpouse","sDirRoleChild","sDefaultCity","sDefaultState","sDefaultCountry","bShowFamilyData","bHidePersonAddress","bHideFriendDate","bHideFamilyNewsletter","bHideWeddingDate","bHideLatLon","cfgForceUppercaseZip","sEnableGravatarPhotos","sEnableSelfRegistration", "bAllowEmptyLastName", "iPersonNameStyle"],
gettext('System Settings') => ["sLastBackupTimeStamp","sExternalBackupAutoInterval","sExternalBackupPassword","sEnableExternalBackupTarget","sExternalBackupType","sExternalBackupEndpoint","sExternalBackupUsername","debug","sLogFile", "bRegistered","sXML_RPC_PATH","sGZIPname","sZIPname","sPGPname","bCSVAdminOnly","sHeader","sEnableIntegrityCheck","sIntegrityCheckInterval","sLastIntegrityCheckTimeStamp"],
gettext('System Settings') => ["sLastBackupTimeStamp","sExternalBackupAutoInterval","sExternalBackupPassword","sEnableExternalBackupTarget","sExternalBackupType","sExternalBackupEndpoint","sExternalBackupUsername","sLogLevel", "bRegistered","sXML_RPC_PATH","sGZIPname","sZIPname","sPGPname","bCSVAdminOnly","sHeader","sEnableIntegrityCheck","sIntegrityCheckInterval","sLastIntegrityCheckTimeStamp"],
gettext('Map Settings') => ["sGeoCoderProvider","sGoogleMapKey","sBingMapKey","sGMapIcons", "iMapZoom","sISTusername","sISTpassword","sGeocoderID","sGeocoderPW"],
gettext('Report Settings') => ["sQBDTSettings","leftX","incrementY","sTaxReport1","sTaxReport2","sTaxReport3","sTaxSigner","sReminder1","sReminderSigner","sReminderNoPledge","sReminderNoPayments","sConfirm1","sConfirm2","sConfirm3","sConfirm4","sConfirm5","sConfirm6","sDear","sConfirmSincerely","sConfirmSigner","sPledgeSummary1","sPledgeSummary2","sDirectoryDisclaimer1","sDirectoryDisclaimer2","bDirLetterHead","sZeroGivers","sZeroGivers2","sZeroGivers3"],
gettext('Localization') => ["sLanguage","sDistanceUnit","sPhoneFormat","sPhoneFormatWithExt","sDateFormatLong","sDateFormatNoYear","sDateFormatShort","sDateTimeFormat","sDateFilenameFormat"],
Expand Down
2 changes: 1 addition & 1 deletion src/Include/Functions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ function RunQuery($sSQL, $bStopOnError = true)
if ($result = mysqli_query($cnInfoCentral, $sSQL)) {
return $result;
} elseif ($bStopOnError) {
if (SystemConfig::getValue('debug')) {
if (SystemConfig::getValue('sLogLevel ') == "100") { // debug level
Copy link
Contributor

Choose a reason for hiding this comment

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

+1

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe make this write to the log instead of die()

Copy link
Contributor

Choose a reason for hiding this comment

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

also, if DEBUG is set, all queries should be logged.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmmm that is now outside MVP... the goal of this PR is to ensure we don't crash... please open a issue to track it

Copy link
Contributor

Choose a reason for hiding this comment

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

#2442

die(gettext('Cannot execute query.')."<p>$sSQL<p>".mysqli_error());
} else {
die('Database error or invalid data');
Expand Down
29 changes: 19 additions & 10 deletions src/Include/LoadConfigs.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,16 +134,25 @@ function buildConnectionManagerConfig($sSERVERNAME, $sDATABASE, $sUSER, $sPASSWO

// enable logs if we are in debug mode
// **************************************************
$logFile = SystemConfig::getValue("sLogFile");
if (SystemConfig::getBooleanValue("debug")) {
$dbClassName = "\\Propel\\Runtime\\Connection\\DebugPDO";
$manager->setConfiguration(buildConnectionManagerConfig($sSERVERNAME, $sDATABASE, $sUSER, $sPASSWORD, $dbClassName));
$logger = new Logger('defaultLogger');
$logger->pushHandler(new StreamHandler($logFile));
$serviceContainer->setLogger('defaultLogger', $logger);
ini_set('log_errors', 1);
ini_set('error_log', $logFile);
}

$logFilePrefix = SystemURLs::getDocumentRoot().'/logs/'.date("Y-m-d");
$logLevel = intval(SystemConfig::getValue("sLogLevel"));

// PHP Logs
ini_set('log_errors', 1);
ini_set('error_log', $logFilePrefix.'-php.log');

// APP Logs
$logger = new Logger('defaultLogger');
$logger->pushHandler(new StreamHandler($logFilePrefix.'-app.log', $logLevel));

// ORM Logs
$ormLogger = new Logger('ormLogger');
$dbClassName = "\\Propel\\Runtime\\Connection\\DebugPDO";
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need a conditional here:

https://github.com/ChurchCRM/CRM/pull/2278/files#diff-e9848400293ecb36fea0aef7708d40f5R138

Copy link
Contributor

Choose a reason for hiding this comment

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

http://propelorm.org/documentation/07-logging.html

You can also disable the debug mode at runtime, by calling PropelPDO::useDebug(false). Using this method, you can choose to enable the debug mode for only one particular query, or for all queries.

Alternatively, you can ask Propel to always enable the debug mode for a particular connection by using the Propel\Runtime\Connection\DebugPDO class instead of the default ConnectionWrapper class. This is accomplished in the configuration file, in the classname node of a given datasource connection (see the configuration reference for more details).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

again please open an issue to track, the goal was not to crash the system

Copy link
Contributor

Choose a reason for hiding this comment

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

#2441

$manager->setConfiguration(buildConnectionManagerConfig($sSERVERNAME, $sDATABASE, $sUSER, $sPASSWORD, $dbClassName));
$ormLogger->pushHandler(new StreamHandler($logFilePrefix.'-orm.log', $logLevel));
$serviceContainer->setLogger('defaultLogger', $ormLogger);


if (isset($_SESSION['iUserID'])) { // Not set on Login.php
// Load user variables from user config table.
Expand Down
1 change: 1 addition & 0 deletions src/logs/.htaccess
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
deny from all