GL.IB.LY » configuration variables http://gl.ib.ly Thoughts on security, computing, business and stuff! Sun, 18 May 2014 11:51:56 +0000 en-US hourly 1 http://wordpress.org/?v=3.9.1 All configuration variables in Moodle code – Part two http://gl.ib.ly/computing/2009/06/24/configuration-variables-moodle-code-part-two/?utm_source=rss&utm_medium=rss&utm_campaign=configuration-variables-moodle-code-part-two http://gl.ib.ly/computing/2009/06/24/configuration-variables-moodle-code-part-two/#comments Wed, 24 Jun 2009 17:53:03 +0000 http://gl.ib.ly/?p=73 Earlier we looked at how you can extract a list of all the $CFG variables in your Moodle code. Now that’s not of much use! We need to know where in the code all these variables hide. I feel some spooky awk a…
Read more ›

The post All configuration variables in Moodle code – Part two appeared first on GL.IB.LY.

]]> Earlier we looked at how you can extract a list of all the $CFG variables in your Moodle code. Now that’s not of much use! We need to know where in the code all these variables hide. I feel some spooky awk a coming on.

Please note this doesn’t show all the variables available in Moodle, it shows all the Moodle variables in a particular codebase. Below output is shown from one of my own codebases which is a little different to what you might expect to see in MOODLE_19_STABLEIn All configuration variables in Moodle code we came up with:

grep -r –no-filename -o ‘\$CFG->[a-z][a-z]*’ <path_to_moodle> | sort -u

This gives us some useful information but hides a lot of the detail. Let’s try and include which files the variable appears in even the line numbers. For this we’ll go back to:

grep -r -no ‘\$CFG->[a-z][a-z]*’

This will print line numbers for matches. Hmmm, what happens if two or more matches are found on one line? Well the second var will be printed without the file and line number — silly badness, see below!

./admin/auth.php:11:$CFG->libdir
./admin/auth.php:12:$CFG->libdir
./admin/auth.php:17:$CFG->wwwroot
$CFG->admin
./admin/auth.php:26:$CFG->auth
./admin/auth.php:29:$CFG->auth
./admin/auth.php:52:$CFG->registerauth
./admin/auth_config.php:7:$CFG->libdir
./admin/auth_config.php:11:$CFG->pagepath

To add some context to $CFG->admin (which appears on line 17 of admin/auth.php) we introduce awk to the fray.

grep -r -no ‘\$CFG->[a-z][a-z]*’ . | awk -F: ‘BEGIN{ s=“” }{ if($3) { print $0; s=$1“:”$2“:”; }else  print s$0; }‘

Here, awk saves the previous line’s first and second fields (separated by ‘:’) if the third field is not empty. If the third field is empty it prepends the first and second fields of the previous line to whatever is on the current line. Nifty, eh? So when we run our command line we now get:

./admin/auth.php:11:$CFG->libdir
./admin/auth.php:12:$CFG->libdir
./admin/auth.php:17:$CFG->wwwroot
./admin/auth.php:17:$CFG->admin
./admin/auth.php:26:$CFG->auth
./admin/auth.php:29:$CFG->auth
./admin/auth.php:52:$CFG->registerauth
./admin/auth_config.php:7:$CFG->libdir
./admin/auth_config.php:11:$CFG->pagepath

Much better! Now that we are getting all the data we can do something useful. Let’s sort everything for convenience.

grep -r -no ‘\$CFG->[a-z][a-z]*’ . | awk -F: ‘BEGIN{ s=“” }{ if($3) { print $0; s=$1“:”$2“:”; }else  print s$0; }‘ | sort -t: -k3

We are sorting our data by the third field in each row. So we tell sort to use ‘:’ as our field delimiter with the -t and we tell sort to use the third field with -k3.

Now we’ll make everything prettier by using awk again (our data should be small enough). We use awk to keep track of the last file and variable awk sees and then make formatting improvements as these values change; e.g. if the Variable changes from $CFG->admin to $CFG->wwwroot then prepend variable name with \n\n which inserts two line returns. This all looks pretty scary…

grep -r -no ‘\$CFG->[a-z][a-z]*’ . | awk -F: ‘BEGIN{ s=“” }{ if($3) { print $0; s=$1“:”$2“:”; }else  print s$0; }‘ | sort -t: -k3 | awk -F: ‘BEGIN{ v=“”; f=“”; }{ if(v!=$3) { v = $3; f=“”; printf “\n\n”$3; } if(f!=$1) { f = $1; printf “\n\t”$1; } printf “:”$2 }‘

This gives us something nice and pretty for our terminal window.

...
$CFG->apachemaxmem
        ./lib/moodlelib.php:7544:7545:7547:7548
$CFG->aspellextradicts
        ./lib/speller/server-scripts/spellchecker.php:27:28
$CFG->aspellpath
        ./admin/settings/appearance.php:57
        ./lib/adminlib.php:2870:2881
        ./lib/editor/htmlarea/htmlarea.php:174:174:279:279
        ./lib/javascript.php:8
        ./lib/speller/changes.txt:19:1:29
        ./lib/speller/server-scripts/spellchecker.php:14:5
        ./lib/weblib.php:4988
...

We can, however, spruce things up a bit for the web:

grep -r -no ‘\$CFG->[a-z][a-z]*’ . | awk -F: ‘BEGIN{ s=“” }{ if($3) { print $0; s=$1“:”$2“:”; }else  print s$0; }‘ | sort -t: -k3 | awk -F: ‘BEGIN{ v=“”; f=“”; }{ if(v!=$3) { v = $3; f=“”; printf “<br /><br /><h1>”$3“</h1>”; }  if(f!=$1) { f = $1; printf “<br><span style=\”font-weight: bold\“>”$1“</span>”; } printf “:”$2 }‘

This gives us something like the following output:

$CFG->ADMIN

./admin/auth.php:17
./admin/auth_config.php:18
./admin/block.php:44
./admin/blocks.php:157:172:237
./admin/collect/cron.php:11
./admin/collect/index.php:108:114:120:126:14:22:22:43:80:91
./admin/collect/lib.php:31:709:75:76
./admin/collect/queue.php:105:106:123:13
./admin/cron.php:168:170
./admin/environment.php:124
./admin/filter.php:16
./admin/filters.php:11
./admin/index.php:422:427:432:437:441:445:448:451:456:459:460:463:464:465:468:471:471:523:602
./admin/lang.php:102:122:127:130:131:132:142:493:754
./admin/langdoc.php:101
./admin/mnet/access_control.php:48:63:76:87
./admin/mnet/adminlib.php:75
./admin/mnet/delete.html:3:4
./admin/mnet/enr_courses.php:40
./admin/mnet/enr_hosts.php:40:52
./admin/module.php:41
./admin/modules.php:201
./admin/pagelib.php:72
./admin/register.php:37
./admin/report/assess/index.php:12:13:193:50
./admin/report/certify/index.php:11:159:270
./admin/report/courseoverview/index.php:18:88
./admin/report/courseoverview/reportsgraph.php:32
./admin/report/lastaccess/index.php:12
./admin/report/lateforleveltwo/index.php:14:86:90
./admin/report/numberofcourses/index.php:12
./admin/report/stats/index.php:31:47
./admin/roles/assign.php:381
./admin/roles/managetabs.php:10:12:14
./admin/roles/override.php:160:187
./admin/roles/tabs.php:182:190
./admin/settings.php:19:42:6
./admin/settings/collect.php:12:17:18:19
./admin/settings/courses.php:12
./admin/settings/frontpage.php:56
./admin/settings/language.php:24:25
./admin/settings/location.php:23
./admin/settings/misc.php:19:23:24:25:26
./admin/settings/mnet.php:13:16:19:22:9
./admin/settings/plugins.php:141:33:41:64
./admin/settings/server.php:161:218:219:247:248
./admin/settings/top.php:16:19:36:46:55
./admin/settings/unsupported.php:10:7:8:9
./admin/settings/users.php:58:71:72:74:75:81:82
./admin/stickyblocks.php:47:73
./admin/upgradesettings.php:31
./admin/uploaduser.php:65:66
./admin/user/user_bulk.php:22:23:24:25:26:5:6
./admin/user/user_bulk_confirm.php:14
./admin/user/user_bulk_delete.php:14
./admin/user/user_bulk_display.php:11
./admin/user/user_bulk_download.php:14
./admin/user/user_bulk_message.php:13
./admin/xmldb/actions/XMLDBAction.class.php:161
./admin/xmldb/index.php:106:78:88
./admin/xmldb/javascript.php:42:43:49:50
./backup/backup.php:104:76:91
./backup/backup_scheduled.php:180
./backup/log.php:11
./backup/restore.php:103:96
./backup/restore_check.html:268
./blocks/admin/block_admin.php:67
./blocks/admin_bookmarks/block_admin_bookmarks.php:55
./blocks/admin_bookmarks/create.php:36
./blocks/admin_bookmarks/delete.php:32
./blocks/admin_tree/block_admin_tree.php:212:67
./blocks/certify/certify.php:11
./blocks/certify/close.php:86
./blocks/certify/config_instance.html:13
./blocks/course_summary/block_course_summary.php:33
./blocks/moodleblock.class.php:475
./blocks/reports/block_reports.php:41:50:85
./blocks/trouble_ticket/thanks.php:25
./calendar/event.php:64
./calendar/export.php:19
./calendar/view.php:54
./config-dist.php:125
./config.php:23
./course/category.php:140:384
./course/delete.php:34:65
./course/edit.php:118:150
./course/editcategory.php:179:323
./course/importstudents.php:19
./course/mod.php:706
./course/modedit.php:446
./course/report/stats/index.php:28
./course/search.php:275
./enrol/authorize/enrol.php:414:746
./enrol/imsenterprise/importnow.php:13
./filter/algebra/algebradebug.php:261
./filter/tex/texdebug.php:263
./grade/report/grader/preferences.php:87
./index.php:38:56:62:74:83
./install.php:139:547
./lib/adminlib.php:3458:3498:3822:3972:3977:3985:4172:4175:4176:4335:776
./lib/db/mysql.php:1473
./lib/db/postgres7.php:1216
./lib/ddllib.php:818:820
./lib/dmllib.php:510
./lib/environmentlib.php:320:323
./lib/moodlelib.php:5099
./lib/pagelib.php:471
./lib/setup.php:184:185
./login/index.php:9
./mod/assignment/lib.php:2837
./mod/glossary/formats.php:27:39
./mod/hotpot/db/update_to_v2.php:519
./my/pagelib.php:59
./question/upgrade.php:90
./user/editadvanced.php:153:158
./user/index.php:100:542:548
./user/tabs.php:225:233:235

$CFG->ADMINBLOCKS

./admin/index.php:522

$CFG->ADMINEDITALWAYS

./config-dist.php:147
./search/documents/forum_document.php:169

$CFG->ADMINSEESALL

./calendar/lib.php:1426:1427

$CFG->ADMINUSEHTMLEDITOR

./admin/settings.php:166
./admin/upgradesettings.php:58
./lib/adminlib.php:2607:2608

$CFG->AJAXCAPABLE

./course/format/topics/ajax.php:7
./course/format/weeks/ajax.php:7
./course/view.php:153:158

$CFG->AJAXTESTEDBROWSERS

./course/format/topics/ajax.php:8
./course/format/weeks/ajax.php:8
./course/view.php:154:161

$CFG->ALLOWCATEGORYTHEMES

./course/category.php:97
./course/editcategory.php:64
./course/editcategory_form.php:20
./lib/weblib.php:3003

$CFG->ALLOWCOURSETHEMES

./course/edit_form.php:143
./lib/weblib.php:2998
./theme/chameleon/ui/chameleon.php:14
./theme/chameleon/ui/css.php:18

$CFG->ALLOWEMAILADDRESSES

./lib/moodlelib.php:4440:4441:4457

$CFG->ALLOWOBJECTEMBED

./lib/weblib.php:6584:6590

$CFG->ALLOWTHEMECHANGEONURL

./lib/setup.php:599

$CFG->ALLOWUNENROL

./lib/db/access.php:383

$CFG->ALLOWUSERBLOCKHIDING

./blocks/moodleblock.class.php:376
./lib/weblib.php:6479

The post All configuration variables in Moodle code – Part two appeared first on GL.IB.LY.

]]> http://gl.ib.ly/computing/2009/06/24/configuration-variables-moodle-code-part-two/feed/ 0 All configuration variables in Moodle code? http://gl.ib.ly/uncategorized/2008/12/15/configuration-variables-moodle-code-2/?utm_source=rss&utm_medium=rss&utm_campaign=configuration-variables-moodle-code-2 http://gl.ib.ly/uncategorized/2008/12/15/configuration-variables-moodle-code-2/#comments Mon, 15 Dec 2008 07:10:15 +0000 http://gl.ib.ly/?p=89 Sometimes Moodle introduces some nice new configuration variables and I like to make sure that I know what they are and where they are. So to begin my investigation without heading off to the web I use the following command…
Read more ›

The post All configuration variables in Moodle code? appeared first on GL.IB.LY.

]]> Sometimes Moodle introduces some nice new configuration variables and I like to make sure that I know what they are and where they are. So to begin my investigation without heading off to the web I use the following command to get me a sorted list of the $CFG variables.

grep -r –no-filename -o ‘\$CFG->[a-z][a-z]*’ <path_to_moodle> | sort -u

Good old trusty grep is used once again. We use grep to recursively, -r, look at all the files in the path_to_moodle. We tell grep to not print out the file names that patterns where found in with –no-filename and the -o option tells grep to output the exact pattern matched. The pattern itself is of the form: starts with “$CFG->” and is followed by one, or more lowercase characters. The pipe to sort -u sorts output and removes duplicate strings.

This command will produce something like the following list which I made using Moodle 1.9.2.

$CFG->admin
$CFG->adminblocks
$CFG->admineditalways
$CFG->adminseesall
$CFG->adminusehtmleditor
$CFG->ajaxcapable
$CFG->ajaxtestedbrowsers
$CFG->allowcategorythemes
$CFG->allowcoursethemes
$CFG->allowemailaddresses
$CFG->allowobjectembed
$CFG->allowthemechangeonurl
$CFG->allowunenrol
$CFG->allowuserblockhiding
$CFG->allowusermailcharset
$CFG->allowuserthemes
$CFG->allowvisiblecoursesinhiddencategories
$CFG->allusersaresitestudents
$CFG->alternateloginurl
$CFG->an
$CFG->apacheloguser
$CFG->apachemaxmem
$CFG->aspellextradicts
$CFG->aspellpath
$CFG->assignment
$CFG->attemptuniqueid
$CFG->auth
$CFG->autolang
$CFG->autologinguests
$CFG->backup
$CFG->block
$CFG->blocks
$CFG->blocksdrag
$CFG->blog
$CFG->bloglevel
$CFG->bounceratio
$CFG->cachetext
$CFG->cachetype
$CFG->calendar
$CFG->chat
$CFG->clamfailureonupload
$CFG->config
$CFG->cookiehttponly
$CFG->cookiesecure
$CFG->country
$CFG->coursemanager
$CFG->coursemanagers
$CFG->coursesperpage
$CFG->coursetheme
$CFG->creatornewroleid
$CFG->cronclionly
$CFG->cronremotepassword
$CFG->currenttextiscacheable
$CFG->customersupportemail
$CFG->customersupportemaildisplay
$CFG->customscripts
$CFG->data
$CFG->datadir
$CFG->dataroot
$CFG->dbfamily
$CFG->dbhost
$CFG->dblogerror
$CFG->dbname
$CFG->dbpass
$CFG->dbpersist
$CFG->dbsessions
$CFG->dbtype
$CFG->dbuser
$CFG->debug
$CFG->debugdisplay
$CFG->debugsmtp
$CFG->decsbureauid
$CFG->decsitemtypeid
$CFG->defaultallowedmodules
$CFG->defaultblocks
$CFG->defaultcourseroleid
$CFG->defaultfrontpageroleid
$CFG->defaultrequestcategory
$CFG->defaultuserroleid
$CFG->deleteunconfirmed
$CFG->denyemailaddresses
$CFG->detect
$CFG->digestmailtime
$CFG->digestmailtimelast
$CFG->directorypermissions
$CFG->dirroot
$CFG->disablebyteserving
$CFG->disablecourseajax
$CFG->disableglobalshack
$CFG->disablegradehistory
$CFG->disablemycourses
$CFG->disablescheduledbackups
$CFG->disablestatsprocessing
$CFG->disableupgradelogging
$CFG->disableuserimages
$CFG->displaydebug
$CFG->displayloginfailures
$CFG->docroot
$CFG->doctonewwindow
$CFG->eaccelerator
$CFG->editorbackgroundcolor
$CFG->editordictionary
$CFG->editorfontfamily
$CFG->editorfontlist
$CFG->editorfontsize
$CFG->editorformatlist
$CFG->editorhidebuttons
$CFG->editorkillword
$CFG->editorspelling
$CFG->editorsrc
$CFG->emailconnectionerrorsto
$CFG->emoticons
$CFG->enableajax
$CFG->enablecourserequests
$CFG->enableglobalsearch
$CFG->enableglobalshack
$CFG->enablegroupings
$CFG->enablehtmlpurifier
$CFG->enableoutcomes
$CFG->enablerecordcache
$CFG->enablerssfeeds
$CFG->enablestats
$CFG->enabletrusttext
$CFG->enrol
$CFG->errordocroot
$CFG->exercise
$CFG->extendedusernamechars
$CFG->extratabs
$CFG->filelifetime
$CFG->filter
$CFG->filterall
$CFG->filtermatchoneperpage
$CFG->filtermatchonepertext
$CFG->filteruploadedfiles
$CFG->footer
$CFG->footerlinks
$CFG->forcefirstname
$CFG->forcelastname
$CFG->forcelogin
$CFG->forceloginforprofiles
$CFG->forcetimezone
$CFG->forgottenpasswordurl
$CFG->formatstring
$CFG->formatstringstriptags
$CFG->forum
$CFG->framename
$CFG->frametarget
$CFG->frontpage
$CFG->frontpageloggedin
$CFG->fullnamedisplay
$CFG->gdversion
$CFG->geoipfile
$CFG->glossary
$CFG->googlemapkey
$CFG->grade
$CFG->gradebookroles
$CFG->gradeexport
$CFG->gradehistorylifetime
$CFG->gradepublishing
$CFG->guestloginbutton
$CFG->guestroleid
$CFG->handlebounces
$CFG->header
$CFG->hiddenuserfields
$CFG->hideactivitytypenavlink
$CFG->hivecbid
$CFG->hivehost
$CFG->hivepassword
$CFG->hivepath
$CFG->hiveport
$CFG->hiveprotocol
$CFG->hiveusername
$CFG->hotpot
$CFG->hotpotismobile
$CFG->hotpotroot
$CFG->hotpottemplate
$CFG->htmleditor
$CFG->httpsthemewww
$CFG->httpswwwroot
$CFG->ignoresesskey
$CFG->intcachemax
$CFG->iplookup
$CFG->javascript
$CFG->journal
$CFG->keeptagnamecase
$CFG->lams
$CFG->lang
$CFG->langcache
$CFG->langlist
$CFG->langmenu
$CFG->lastexpirynotify
$CFG->lastnotifyfailure
$CFG->latinexcelexport
$CFG->ldap
$CFG->libdir
$CFG->local
$CFG->locale
$CFG->loginaspassword
$CFG->loginhttps
$CFG->loglifetime
$CFG->logsql
$CFG->longtimenosee
$CFG->maildomain
$CFG->mailnewline
$CFG->mailprefix
$CFG->max
$CFG->maxbytes
$CFG->maxeditingtime
$CFG->memcachedhosts
$CFG->memcachedpconn
$CFG->message
$CFG->messagewasjustemailed
$CFG->messaging
$CFG->migrated
$CFG->minbounces
$CFG->minpassworddigits
$CFG->minpasswordlength
$CFG->minpasswordlower
$CFG->minpasswordnonalphanum
$CFG->minpasswordupper
$CFG->mnet
$CFG->moddata
$CFG->modpixpath
$CFG->my
$CFG->mymoodleredirect
$CFG->noconvertjournals
$CFG->nodefaultuserrolelists
$CFG->noemailever
$CFG->nofixday
$CFG->nolastloggedin
$CFG->nonmetacoursesyncroleids
$CFG->noreplyaddress
$CFG->notifyloginfailures
$CFG->notifyloginthreshold
$CFG->notloggedinroleid
$CFG->old
$CFG->opentogoogle
$CFG->os
$CFG->ostype
$CFG->pagepath
$CFG->pagetheme
$CFG->passwordpolicy
$CFG->passwordsaltmain
$CFG->pathtoclam
$CFG->pathtodu
$CFG->perfdebug
$CFG->pixpath
$CFG->preferlinegraphs
$CFG->prefix
$CFG->preventaccesstohiddenfiles
$CFG->protectusernames
$CFG->proxyhost
$CFG->proxypassword
$CFG->proxyport
$CFG->proxytype
$CFG->proxyuser
$CFG->qtype
$CFG->quarantinedir
$CFG->quiz
$CFG->rcache
$CFG->rcachettl
$CFG->recaptchaprivatekey
$CFG->recaptchapublickey
$CFG->registerauth
$CFG->registered
$CFG->release
$CFG->repository
$CFG->repositoryactivate
$CFG->repositorywebroot
$CFG->resource
$CFG->resourcetrimlength
$CFG->respectsessionsettings
$CFG->restrictbydefault
$CFG->restrictmodulesfor
$CFG->rolesactive
$CFG->runclamonupload
$CFG->running
$CFG->scorm
$CFG->search
$CFG->session
$CFG->sessioncookie
$CFG->sessioncookiepath
$CFG->sessiontimeout
$CFG->showblocksonmodpages
$CFG->showcrondebugging
$CFG->showcronsql
$CFG->siteblocksadded
$CFG->siteidentifier
$CFG->sitemailcharset
$CFG->sitepolicy
$CFG->slasharguments
$CFG->smartpix
$CFG->smtphosts
$CFG->smtpmaxbulk
$CFG->smtppass
$CFG->smtpuser
$CFG->sso
$CFG->statscatdepth
$CFG->statsfirstrun
$CFG->statsmaxruntime
$CFG->statsrolesupgraded
$CFG->statsruntimestarthour
$CFG->statsruntimestartminute
$CFG->statsuserthreshold
$CFG->stringfilters
$CFG->stylesheets
$CFG->supportemail
$CFG->supportname
$CFG->supportpage
$CFG->tagsort
$CFG->template
$CFG->textfilters
$CFG->textfilterx
$CFG->theme
$CFG->themedir
$CFG->themelist
$CFG->themeorder
$CFG->themewww
$CFG->timezone
$CFG->tracksessionip
$CFG->type
$CFG->unicodecleanfilename
$CFG->unicodedb
$CFG->unzip
$CFG->upgrade
$CFG->usepaypalsandbox
$CFG->usesid
$CFG->usetags
$CFG->version
$CFG->wiki
$CFG->wordlist
$CFG->workshop
$CFG->wwwdir
$CFG->wwwroot
$CFG->xml
$CFG->xmldbdisablecommentchecking
$CFG->xmldbdisablenextprevchecking
$CFG->xmldbreconstructprevnext
$CFG->xmlstrictheaders
$CFG->zip

The post All configuration variables in Moodle code? appeared first on GL.IB.LY.

]]> http://gl.ib.ly/uncategorized/2008/12/15/configuration-variables-moodle-code-2/feed/ 1