Difference between revisions of "Cchost/guide/Troubleshooting"

From Creative Commons
Jump to: navigation, search
(New page: Category:ccHost Category:ccMixter Category:Developer Category:Software Category:Technology {{cchost_head}} {{lowercase}} = Known Issues = Please consult our [https://so...)
 
(Variable Dumps)
Line 38: Line 38:
  
 
To dump the internal dataview use '''dpreview=1''' instead.
 
To dump the internal dataview use '''dpreview=1''' instead.
 +
===Developer Dumps===
 +
ccHost developers have several options for dumping specific variables and getting state information.
 +
 +
All of these assume that debug mode has been enabled somewhere:
 +
 +
  CCDebug::Enable(true);
 +
 +
For dumping a variable to the screen:
 +
 +
  CCDebug::PrintVar($var);
 +
 +
For sending text to the log file determined at '''admin/paths''':
 +
 +
  CCDebug::Log($text);
 +
 +
To dump a variable to the log use:
 +
 +
  CCDebug::LogVar( $text, $var );
 +
 +
Since ccHost is event based it's not always to figure "how I got here." For an abbreviated stack trace:
 +
 +
  CCDebug::StackTrace();
 +
 +
For a full blown (very expansive) version:
 +
 +
  CCDebug::StackTrace( false, true );
  
 
=Repairing a broken configuration (A.K.A. HELP!!!!)=
 
=Repairing a broken configuration (A.K.A. HELP!!!!)=

Revision as of 22:07, 13 November 2008


Docs Home Install Upgrade Troubleshoot Customize Admins Devs Content Query Templates Commands Skins

Known Issues

Please consult our bug tracker for the latest list of unresolved issues.

File Access

By far the most common issue with new installs on Unix based systems involves file access permissions. The recommended way of dealing with this is to set the entire ccHost directory structure as all-access (0777) just while you get things going. If everything else is working then you should follow the ccHost file access guildlines.

Outputting Debug Messages

Debug messages are special messages that help ccHost developers troublshoot your site when there is a problem. The option to turn on debug message output is on by default in 5.0 installations and upgrades. The file that controls this option is <your_local_files>/lib/DEBUG.php. You can remove this file (or change the extension to something other than .php) and that will turn the option off debug output for your production site.

Variable Dumps

You can dump various records and environment variable at any time, right onto the screen.

First, you must enable debug mode as described above.

Then, as long as you logged in as admin, on any page browse to:

 <your_installation_root>?dump_page=1

That will list out all the global variables available to you (the user record is the currently logged in user).

To view the first record of the current page's Query API record results:

 <your_installation_root>?dump_rec=1

In other words, you can append dump_rec=1 to almost any URL to see what the Query API is returning:

 <your_installation_root>/files/victor/1234?dump_rec=1
 <your_installation_root>/people/teru?dump_rec=1
 <your_installation_root>/api/query?tags=remix&user=loveshadow&dump_rec=1

That will list out all the variables in a given upload record (the user record here is the one that uploaded the thing).

To dump the internal dataview use dpreview=1 instead.

Developer Dumps

ccHost developers have several options for dumping specific variables and getting state information.

All of these assume that debug mode has been enabled somewhere:

 CCDebug::Enable(true);

For dumping a variable to the screen:

 CCDebug::PrintVar($var);

For sending text to the log file determined at admin/paths:

 CCDebug::Log($text);

To dump a variable to the log use:

 CCDebug::LogVar( $text, $var );

Since ccHost is event based it's not always to figure "how I got here." For an abbreviated stack trace:

 CCDebug::StackTrace();

For a full blown (very expansive) version:

 CCDebug::StackTrace( false, true );

Repairing a broken configuration (A.K.A. HELP!!!!)

If you get into 'trouble' with your system you might be able to salvage your site by browsing to one of these URLs:

  • <your_root_installation>/admin/edit
  • <your_root_installation>?ccm=/media/admin/edit
  • <your_root_installation>/cchost_lib/cc-config-repair.php

If you are not logged in as an administrator when trying this you will have to:

  • Open the cchost_lib/cc-config-repair.php file in a text editor
  • Remove the two forward slashes // before the word 'return' in the line at the top of the file
  • Save this file to disk
  • From your browser, go to <your_root_installation>/cchost_lib/cc-config-repair.php. (This should bring up a configuration editor)
  • Click on the word media to open the configuration settings and see if you can spot the error
  • After you have fixed (or decided you can't fix) the problem make sure to the put the // back into the cchost_lib/cc-config-repair.php file otherwise you will leave a large gaping security hole in your site