Creative Commons - User contributions [en]

CcHost

2009-08-09T23:21:23Z

Fourstones: /* Current Stable Release */

[[Category:ccHost]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
[[Category:ccMixter]]
{{Project}}
{{lowercase}}

'''ccHost''' is Creative Commons' open source ([http://creativecommons.org/licenses/GPL/2.0/ GPL] licensed) [http://en.wikipedia.org/wiki/Content_management_system content management system] project that powers [http://ccmixter.org ccMixter] and is the winner of the [http://creativecommons.org/weblog/entry/6026 Linux Journal LinuxWorldExpo Product Excellence Award] for '''Best Open Source Solution.''' Read more about ccHost [[#Zeitgeist|here]].

= Download =

Sign up for [http://sourceforge.net/export/rss2_projfiles.php?group_id=80503 our RSS release feed] to make sure you don't miss important bug fixes and feature updates.

=== Current Stable Release ===
Latest stable build of [https://sourceforge.net/projects/cctools/files/ccHost/ ccHost 5.1] is available in ZIP archive format.

= Documentation =

[[cchost/Documentation|ccHost 5 Documentation]]

=Communication=

=== People ===
* [[User:fourstones|Victor Stone]]
* [[User:Jon Phillips|Jon Phillips]]
=== Contacting ===
The mailing list is the best way to get our attention. That and other methods are listed below:
* Mailing List: https://lists.sourceforge.net/mailman/listinfo/cctools-cchost
** [http://sourceforge.net/mailarchive/forum.php?forum=cctools-cchost Archive]
* Chat: #cc on irc.freenode.net
* Wiki: This page (http://wiki.creativecommons.org/CcHost)
* [[Cchost/Developers#Bugs_and_Feature_Requests|Bugs and feature requests]]

= Zeitgeist =
=== Goal ===
The goal of this project is to spread media content that is licensed under Creative Commons throughout the web in much the same way that weblogs spread CC licensed text.
=== Short Description ===
"Web-based System Supporting Remixing and Collaboration on Media"
=== Slightly Longer Description ===
'''ccHost''' is an open source ([http://creativecommons.org/licenses/GPL/2.0/ GPL] licensed) project that provides web-based infrastructure to support collaboration, sharing, and storage of multi-media using the Creative Commons licenses and metadata. It is the codebase used by [http://ccmixter.org ccMixter] and [[#Usage Examples|other sites]].

Besides its focus on sharing content, ccHost differentiates itself from other multi-media hosting programs by emphasizing the '''reuse''' (a.k.a. remixing) of content between artists, not only between artists on any given installation of ccHost, but between all installations across the web and any web site that implements the Creative Commons [http://ccmixter.org/media/viewfile/pool_api_doc.xml Sample Pool API], including non-ccHost sites such as the [http://freesound.iua.upf.edu/ freesound project].

=== Usage Examples ===

* [http://ccmixter.org ccMixter] - Primary usage of ccHost is the Creative Commons remix site, ccMixter.
* [http://www.openclipart.org/ Open Clip Art Library ccHost in testing]
* [http://www.openfontlibrary.org Open Font Library]
* [http://freemusic.freeculture.org Freemusic Project]
* [http://www.opensourcecinema.com/cchost Open Source Cinema]
* [http://rayne.hellawack.net/ Matrix Rayne Online]
* [http://remix.machinehasnoagenda.com/ remix.linux]
* [http://www.ccmixter.co.za/ ccmixter South Africa]
* [http://fourstones.net fourstones.net] Victor's personal website
* [http://www.esolpc.com/teacherhost/ TeacherHost] - for Instructors to share instructional materials.
* [http://adrenalinicsound.com/ Adrenalinic Sound]
* [http://creativecommons.org.tw/formoz ccMixter from CC Taiwan]
* [http://www.overmundo.com.br/overmixter Overmixter - Brazil]
* [http://www.iamacc.org/ Iamacc.org]
* [http://www.enciclopediacecilia.org/musicast/ Remix Cecilia] at the Enciclopedia Cecilia project, music in the catholic church.

----

= Appendix A: Compatibility =

=== Browsers ===

Recently tested on: Firefox 2/3 Mac/PC/Linux, IE 7 PC, Safari Mac (IE8 requires "compatibility" mode - see [[Cchost/guide/Troubleshooting#IE8_Layout_Issues|here]] for workaround)

Cookies must be enabled.

Most skins (the ones people will want to use) require Javascript enabled.

=== Servers ===

Primary development is done on Ubuntu 8.04 (hardy heron) using Apache, mySQL, and PHP. The actual dev setup is described in detail [[Cchost/Developers/Victor's_Dev_Setup|here]].

==== Linux ====
ccHost on Apache (2.0.49 up to at least apache-2.0.55-r1) on Linux,

One should be able to easily install mySQL, PHP, and Apache (if they are not already available) through their distributions packaging system. See the dev setup above.

==== Windows IIS Server ====

{{Infobox|ccHost has not been seen running or tested on Windows for a long time - several versions ago.}}

Windows users with their installation disks may install optionally the Windows IIS Web Server. This option has been tested. However, there might still be issues with it, and if so, [http://sourceforge.net/tracker2/?func=browse&group_id=80503&atid=559966 please file a bug].

Even if you using Apache on Windows you may need to have IIS installed if you plan to use mail contact functions.

==== Windows Apache ====
There are many good tutorials for setting up a Windows/Apache/MySQL/PHP site ([http://google.com/search?q=installing+WAMP Google search]) and all three subsystems now come with Windows installers making the job of installing relatively straightforward.

====== XAMPP ======
Windows installations without Apache, mySQL and PHP already installed should consider using [http://www.apachefriends.org/en/xampp.html XAMPP] for Windows, which provides an easy install of Apache web server, MySQL database server, and PHP and perl programming languages. This is an easy way to get up and running, with the underlying technology necessary to use ccHost.

Follow the instructions for installation of XAMPP to know where to put the uncompressed ccHost package to properly work with your local setup.

==== Mac OS X ====

''NOTE: This setup is similar to Linux.''

Verified:

* OS X 10.4.6
* default OS X MySQL build, 4.0.26
* GetID3 1.7.7
* default Apache/PHP

Cchost/Concepts

2009-06-16T05:27:10Z

Fourstones: Created page with '=Concepts= *Content *Query Engine *Templates *Commands *[[...'

Cchost/concepts/Social Interaction

2009-06-16T05:21:07Z

Fourstones: /* Reviewing */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{cchost_5_1}}
{{lowercase}}
=Background=
The main form of interaction at a ccHost site, the one that differentiates it from most other content management systems, is deriving works from each other (a.k.a. remixing). Rather than sharing status messages, being in a circle of "friends" or "followers," the artists are having a conversation with the media itself.

ccHost ''does'' offer ways of interacting that relate directly to the media. In this document we'll discuss the various ways people can show their appreciation and even help "market" the content.

==Ratings==
ccHost offers admins a choice between two types of ratings system. The "star" method ''or'' the "recommends" method. (The recommends system is also referred to as the "thumbs up" method.)

You can not enable ''both'' the start method and the recommend method at the same time. It's one or the other.

===The 5 Star Method===
When the star system is enabled, a strip of 5 graphical stars appears with every upload. When a user that is eligible for rating hovers over the stars, they change color indicating they can choose one to signify their ratings.

Ratings are stored in the database as a number between 1 and 5. (Technically the number stored is 100 times the rating.)

To enable the star system click on ''Global Settings'' then ''Ratings'' (or browse to '''admin/ratings'''). In that form check the ''Ratings'' option and un-check the ''Use 'Recommend' style''.

Administering a site with a star rating system can require a lot of tweaking when the system is abused (i.e. a "1 star bombing run"). In order to watch and correct abuses browse to '''admin/ratings/manage''' which allows you to view specific activity. Click on the ''reviewers'' name to filter just one user or the upload name to filter on a specific upload. Likewise for IP, ratings and upload.
===Recommends (Thumbs Ups)===
===Who Can Rate?===
Only registered users can rate and artists can not rate/recommend themselves.
==Reviewing==
==Playlist/Collections/Favorites==

Cchost/concepts/Social Interaction

2009-06-16T05:20:42Z

Fourstones: Created page with 'Category:ccHost Category:ccMixter Category:Developer Category:Software Category:Technology {{cchost_head}} {{cchost_5_1}} {{lowercase}} =Background= The main ...'

User talk:Fourstones

2009-06-16T04:38:10Z

Fourstones: /* "dead page"? */

=="dead page"?==
What did you mean to do in [http://wiki.creativecommons.org/index.php?title=CcHost_Community_Building&diff=19674&oldid=1431 this edit]? If you'd like the pages deleted, I'd be happy to do that; you can mark them with <nowiki>{{del}}</nowiki>, or just ask me. If you mean something else, a clarification would be helpful. [[User:JesseWeinstein|JesseWeinstein]] 23:40, 12 June 2009 (UTC)

:I don't remember but yes, it's a dead page. Thanks. [[User:Fourstones|Fourstones]] 04:36, 16 June 2009 (UTC)

User talk:Fourstones

2009-06-16T04:36:54Z

Fourstones: /* "dead page"? */

=="dead page"?==
What did you mean to do in [http://wiki.creativecommons.org/index.php?title=CcHost_Community_Building&diff=19674&oldid=1431 this edit]? If you'd like the pages deleted, I'd be happy to do that; you can mark them with <nowiki>{{del}}</nowiki>, or just ask me. If you mean something else, a clarification would be helpful. [[User:JesseWeinstein|JesseWeinstein]] 23:40, 12 June 2009 (UTC)

I don't remember but yes, it's a dead page. Thanks. [[User:Fourstones|Fourstones]] 04:36, 16 June 2009 (UTC)

User talk:Fourstones

2009-06-16T04:33:57Z

Fourstones: /* "dead page"? */

=="dead page"?==
What did you mean to do in [http://wiki.creativecommons.org/index.php?title=CcHost_Community_Building&diff=19674&oldid=1431 this edit]? If you'd like the pages deleted, I'd be happy to do that; you can mark them with <nowiki>{{del}}</nowiki>, or just ask me. If you mean something else, a clarification would be helpful. [[User:JesseWeinstein|JesseWeinstein]] 23:40, 12 June 2009 (UTC)

I don't remember but yes, it's a dead page. Thanks.

Cchost/Developers

2009-06-12T18:56:29Z

Fourstones: /* New Checkout */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
=External APIs=
[[cchost/concepts/APIs|APIs]]

= Source Code =
* [http://code.creativecommons.org/svnroot/cchost/trunk/ Browsable Source Code (Anonymous)]
* [http://code.creativecommons.org/viewsvn/cchost/trunk/ Pretty version]
* [http://wiki.creativecommons.org/Source_Repository_Information How to Check Out Code]
**Specifically for ccHost:
*** Log in as administrator on your ccHost installation
*** '''Then''' do your svn update
*** Browse to <nowiki>http://your_installation?update=1</nowiki>

{{Infobox|The source for ccHost has moved from SourceForge. For existing clients: you must perform the svn 'relocate' command to switch over. To do this, change directory to the root of your ccHost svn project, then perform the following command:

svn switch --relocate <nowiki>https://cctools.svn.sourceforge.net/svnroot/cctools http://code.creativecommons.org/svnroot</nowiki>
}}

== New Checkout ==

Use the following command to get the latest source control version of the code:

svn co http://code.creativecommons.org/svnroot/cchost/trunk LOCAL_CCHOST_PATH

(Substitute a path to put the code into. Dot (.) is valid for the current directory)

{{Infobox|'''NOTE''': This is only an anonymous public checkout. If you want to commit, you will need to visit [http://code.creativecommons.org the CC code site].}}

=When to make changes to ccHost core=
Never.
==Seriously==
Never.
==But I have changes to share==
Oh, that's different. Definitely [[HOWTO_Patch|submit a patch]]! But before going too far down this road you definitely want to hop on the [https://lists.sourceforge.net/mailman/listinfo/cctools-cchost dev mailing list]. If you are shy ask to speak with Victor or Jon in private.

= Bugs and Feature Requests =
* [https://sourceforge.net/tracker/?atid=559966&group_id=80503&func=browse Report Bugs]
* [https://sourceforge.net/tracker/?group_id=80503&atid=559969 Request Features]

''Make sure to use the 'ccHost' category when filing bugs. Also, please use a real email so that we can followup on any bugs posted. Be descriptive when posting and commenting on bugs (every bit counts).''

=Coding in ccHost=
==ccHost's Model for a 'Module'==
There is no formalized higher level model for a 'module' or 'plugin' in ccHost. The model is the same as PHP: a source file. All files with a .PHP extension that reside in the '''<local_files>/lib''' directory will be parsed and executed for every page request to a ccHost installation. Where <local_files> is the name of the directory the administrator specified during installation as to where site customizations reside (also editable from '''admin/paths''')

Because of the automatic loading you should be aware of some performance and timing considerations.

===Keep Per Page Execution at a Minimum===
You should have no significant code that executes outside of functions. You module will be loaded on each every page (and AJAX) request so (other than registering for ccHost events) you should keep all your code in functions that get called in response to ccHost events.

<nowiki><?</nowiki>
for( $i = 0; $i < 52; $i++ ) { $deck[] = rand() % 52; } '''// this is bad'''
<nowiki>?></nowiki>

Instead of the above, you would do:

<nowiki><?</nowiki>
function start_my_shuffle()
{
global $deck;

for( $i = 0; $i < 52; $i++ ) { $deck[] = rand() % 52; }
}

// no we only do the shuffle once after ever upload
CCEvents::AddHandler( CC_EVENT_UPLOAD_DONE, 'start_my_shuffle' );
<nowiki>?></nowiki>

===Wait for Initialization===
It is rare that you will want to do anything before the environment is fully initialized and we know who the currently logged in user really is.

If you really need to do some calculation on each page hit, register for the 'APP_INIT' event and perform it then:

<nowiki><?</nowiki>

CCEvents::AddHandler( CC_EVENT_APP_INIT, 'my_app_init_func' );

function my_app_init_func()
{
global $CC_GLOBALS;

if( CCUser::IsLoggedIn() )
{
$CC_GLOBALS['welcome-message'] = 'Hello ' . CCUser::CurrentUserName() . '!';
}
}

<nowiki>?></nowiki>

===Keep Per Page Code Size at a Minimum===
If you plan on having a lot of extensibility code it would be wise for performance reasons to consider what ''has'' to go into the .PHP files and what can be put into other files (e.g. '.inc') and loaded on demand.

The typical way to handle this is to put the event registrations in the PHP module and the code in a INC file. You can specify a script module in the third parameter of '''AddHandler'''. Assuming this file is '''<local_files>/lib/my_event_hooks.php'''

<nowiki><?</nowiki>
CCEvents::AddHandler( CC_EVENT_APP_INIT, 'my_app_init_func', dir(__FILE__) . '/my_code.inc' );
<nowiki>?></nowiki>

Then you create '''<local_files>/lib/my_code.inc''':

<nowiki><?</nowiki>

function my_app_init_func()
{
global $CC_GLOBALS;

if( CCUser::IsLoggedIn() )
{
$CC_GLOBALS['my-welcome-message'] = 'Hello ' . CCUser::CurrentUserName() . '!';
}
}

<nowiki>?></nowiki>

=Useful Reading=

These pages have important developer information and code samples:

*[[cchost/guide/Customize|Customize]] <--- '''Always check here first'''
*[[cchost/guide/Troubleshooting#Variable_Dumps|Variable dumps]]
*[[cchost/Static HTML Pages|Static Pages]]
*[[cchost/admin/config customize|Configuration files]]
*[[cchost/Custom Query Templates|Custom Query Templates]]
*[[Cchost/Developers/Victor's_Dev_Setup|Victor's Dev Setup]]

These pages are developer specific:

*[[cchost/developer/Common_HOWTO's|Common developer HOWTO's]]
*[[cchost/developer/concepts/Working With Data|Working with data]]
*[[cchost/developer/Hooking Page Render|Hooking Page Render]]
*[[cchost/developer/Hooking the User Profile|Hooking the User Profile]]
==Tutorials==
*[[cchost/developer/tutorial/Hooking File Events|Tutorial: Hooking File Events]]
*[[Cchost/developer/tutorial/Replacing the File Verifier|Tutorial: Replacing the File Verifier]]
*[[Cchost/developer/tutorial/Ultimate Template|Tutorial: Ultimate Template]]
*[[Cchost/developer/tutorial/Remix_Me|Tutorial: ccMixter's "Remix Me" Feature]] Covers custom templates, embedded custom dataview, 'publicize', popup window, nested templates, feature page
*[[cchost/developer/tutorial/Featured_Playlist|Tutorial: ccMixter's Featured Playlist]] Covers content topics, database insert, command menus, event handling.

Cchost/Developers

2009-06-12T18:49:10Z

Fourstones: /* New Checkout */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
=External APIs=
[[cchost/concepts/APIs|APIs]]

= Source Code =
* [http://code.creativecommons.org/svnroot/cchost/trunk/ Browsable Source Code (Anonymous)]
* [http://code.creativecommons.org/viewsvn/cchost/trunk/ Pretty version]
* [http://wiki.creativecommons.org/Source_Repository_Information How to Check Out Code]
**Specifically for ccHost:
*** Log in as administrator on your ccHost installation
*** '''Then''' do your svn update
*** Browse to <nowiki>http://your_installation?update=1</nowiki>

{{Infobox|The source for ccHost has moved from SourceForge. For existing clients: you must perform the svn 'relocate' command to switch over. To do this, change directory to the root of your ccHost svn project, then perform the following command:

svn switch --relocate <nowiki>https://cctools.svn.sourceforge.net/svnroot/cctools http://code.creativecommons.org/svnroot</nowiki>
}}

== New Checkout ==

''NOTE: This is only an anonymous public checkout. If you want to commit, you will need to visit [http://code.creativecommons.org the CC code site].

svn co svn list svn+ssh://svn@code.creativecommons.org/svnroot/cchost/tags/5_0_1 cchost_path_you_desire

Make sure that you are checking out the latest tagged release by running this command:

svn list svn list svn+ssh://svn@code.creativecommons.org/svnroot/cchost/tags/

Pick the highest revision number, at this time is 5_0_1. Place this at the end of the url:

svn co svn list svn+ssh://svn@code.creativecommons.org/svnroot/cchost/tags/LATEST_VERSION_NUMBER

=When to make changes to ccHost core=
Never.
==Seriously==
Never.
==But I have changes to share==
Oh, that's different. Definitely [[HOWTO_Patch|submit a patch]]! But before going too far down this road you definitely want to hop on the [https://lists.sourceforge.net/mailman/listinfo/cctools-cchost dev mailing list]. If you are shy ask to speak with Victor or Jon in private.

= Bugs and Feature Requests =
* [https://sourceforge.net/tracker/?atid=559966&group_id=80503&func=browse Report Bugs]
* [https://sourceforge.net/tracker/?group_id=80503&atid=559969 Request Features]

''Make sure to use the 'ccHost' category when filing bugs. Also, please use a real email so that we can followup on any bugs posted. Be descriptive when posting and commenting on bugs (every bit counts).''

=Coding in ccHost=
==ccHost's Model for a 'Module'==
There is no formalized higher level model for a 'module' or 'plugin' in ccHost. The model is the same as PHP: a source file. All files with a .PHP extension that reside in the '''<local_files>/lib''' directory will be parsed and executed for every page request to a ccHost installation. Where <local_files> is the name of the directory the administrator specified during installation as to where site customizations reside (also editable from '''admin/paths''')

Because of the automatic loading you should be aware of some performance and timing considerations.

===Keep Per Page Execution at a Minimum===
You should have no significant code that executes outside of functions. You module will be loaded on each every page (and AJAX) request so (other than registering for ccHost events) you should keep all your code in functions that get called in response to ccHost events.

<nowiki><?</nowiki>
for( $i = 0; $i < 52; $i++ ) { $deck[] = rand() % 52; } '''// this is bad'''
<nowiki>?></nowiki>

Instead of the above, you would do:

<nowiki><?</nowiki>
function start_my_shuffle()
{
global $deck;

for( $i = 0; $i < 52; $i++ ) { $deck[] = rand() % 52; }
}

// no we only do the shuffle once after ever upload
CCEvents::AddHandler( CC_EVENT_UPLOAD_DONE, 'start_my_shuffle' );
<nowiki>?></nowiki>

===Wait for Initialization===
It is rare that you will want to do anything before the environment is fully initialized and we know who the currently logged in user really is.

If you really need to do some calculation on each page hit, register for the 'APP_INIT' event and perform it then:

<nowiki><?</nowiki>

CCEvents::AddHandler( CC_EVENT_APP_INIT, 'my_app_init_func' );

function my_app_init_func()
{
global $CC_GLOBALS;

if( CCUser::IsLoggedIn() )
{
$CC_GLOBALS['welcome-message'] = 'Hello ' . CCUser::CurrentUserName() . '!';
}
}

<nowiki>?></nowiki>

===Keep Per Page Code Size at a Minimum===
If you plan on having a lot of extensibility code it would be wise for performance reasons to consider what ''has'' to go into the .PHP files and what can be put into other files (e.g. '.inc') and loaded on demand.

The typical way to handle this is to put the event registrations in the PHP module and the code in a INC file. You can specify a script module in the third parameter of '''AddHandler'''. Assuming this file is '''<local_files>/lib/my_event_hooks.php'''

<nowiki><?</nowiki>
CCEvents::AddHandler( CC_EVENT_APP_INIT, 'my_app_init_func', dir(__FILE__) . '/my_code.inc' );
<nowiki>?></nowiki>

Then you create '''<local_files>/lib/my_code.inc''':

<nowiki><?</nowiki>

function my_app_init_func()
{
global $CC_GLOBALS;

if( CCUser::IsLoggedIn() )
{
$CC_GLOBALS['my-welcome-message'] = 'Hello ' . CCUser::CurrentUserName() . '!';
}
}

<nowiki>?></nowiki>

=Useful Reading=

These pages have important developer information and code samples:

*[[cchost/guide/Customize|Customize]] <--- '''Always check here first'''
*[[cchost/guide/Troubleshooting#Variable_Dumps|Variable dumps]]
*[[cchost/Static HTML Pages|Static Pages]]
*[[cchost/admin/config customize|Configuration files]]
*[[cchost/Custom Query Templates|Custom Query Templates]]
*[[Cchost/Developers/Victor's_Dev_Setup|Victor's Dev Setup]]

These pages are developer specific:

*[[cchost/developer/Common_HOWTO's|Common developer HOWTO's]]
*[[cchost/developer/concepts/Working With Data|Working with data]]
*[[cchost/developer/Hooking Page Render|Hooking Page Render]]
*[[cchost/developer/Hooking the User Profile|Hooking the User Profile]]
==Tutorials==
*[[cchost/developer/tutorial/Hooking File Events|Tutorial: Hooking File Events]]
*[[Cchost/developer/tutorial/Replacing the File Verifier|Tutorial: Replacing the File Verifier]]
*[[Cchost/developer/tutorial/Ultimate Template|Tutorial: Ultimate Template]]
*[[Cchost/developer/tutorial/Remix_Me|Tutorial: ccMixter's "Remix Me" Feature]] Covers custom templates, embedded custom dataview, 'publicize', popup window, nested templates, feature page
*[[cchost/developer/tutorial/Featured_Playlist|Tutorial: ccMixter's Featured Playlist]] Covers content topics, database insert, command menus, event handling.

Cchost/guide/Installing

2009-06-12T18:47:20Z

Fourstones:

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
=Getting ccHost=
Check [[Cchost#Download|ccHost home page]] for download instructions of the latest stable release.

For instructions on the getting the latest snapshot directly from our source control system check the [[Cchost/Developers#Source_Code|source code home page]].

=Installing=
== Simple ==
The easiest way to get going is to start with a web hosting server. Common web hosting services like [http://www.brainpulse.com BrainPulse] , [http://www.dreamhost.com/ Dreamhost] and [http://www.websitesource.com WebsiteSource] provide an administration interface for setting up a mysql database. Hosting services also provide some FTP or SFTP mechanism to upload the ccHost installation files as well. 99% of all services provide support for PHP as well. If you have questions about support in this area, check the server requirements below and with your hosting service.

#Unzip the ccHost ZIP archive on your local system and copy the files to your server retaining the the directory structure.
#Browse to '''<nowiki>http://where_you_installed</nowiki>''' and follow all the instructions from then on.

== Advanced ==
If you have basic knowledge of using FTP and you are comfortable at a terminal command line you can use these steps. Many of these can be filed under "you'll be glad you did" by the time you get to the browser-based installation steps later on.

=== Download/Install getID3 ===
ccHost depends on the getID3 library for verifying uploads. Install getID3 (at least 1.7.3) here: http://www.getid3.org/#download before you install ccHost. (It's a simple download-unpack operation.)

Note: Make sure the release you install is marked as '''stable'''. Do ''not'' install anything that is "beta" or "alpha"

For example (on Linux):

<pre>
tar xzf getid3.tar.gz
cp -a getid3/getid3 /var/www/localhost/htdocs/getid3/
</pre>

The ccHost installer will 'find' your getID3 installation if it's roughly in the same area of the server, however it is ''not'' required that your getID3 be visible on the web and in fact, it's probably more secure if it isn't.

{{Infobox|BUG WARNING: Later versions of getID3 (starting with 1.7.7) have an issue with RIFF based files (WAV, AVI, etc.) when tagging them and require a manual patch in order to work properly. Remove line #105 in getID3/write.php that looks like:
case 'riff': // maybe not officially, but people do it anyway }}

=== ccHost Terminal Installtion ===
* Unzip the ccHost ZIP archive on your local system and copy the files (retaining the directory structure) to your web-server directory.
* On Linux change the group and permissions of the files so they may be written by the web server (e.g., in the following lines, the web-server account is "apache").
For example:
<pre>
cp -a cchost-1.0.3 /var/www/localhost/htdocs/cchost
chgrp -R apache /var/www/localhost/htdocs/cchost
chmod g+w /var/www/localhost/htdocs/cchost/
</pre>
*Create a new database for ccHost (e.g., named "cchost") and create an administrative user to access it (e.g., "cchostadmin"). For example:
<pre>
mysql -p -u root
mysql> CREATE DATABASE cchost;
mysql> GRANT ALL ON cchost.* TO 'cchostadmin'@'localhost' IDENTIFIED BY 'YOUR_PASSWORD_HERE';
</pre>
Make sure to change 'YOUR_PASSWORD_HERE' (and maybe 'cchostadmin') to something unique to your site.
(Many systems provide '''phpMyAdmin''' to take care of these tasks.
*Create directory /var/log/cchost or other location to store log files. Must be writable by the web-server account (e.g., "apache"). For example:
<pre>
mkdir /var/log/cchost
chown apache:apache /var/log/cchost
</pre>

There are several suggestions for mod_rewrite and configuration settings [[cchost/admin/apache/config|here]].

Browse to '''<nowiki>http://where_you_installed_cchost</nowiki>'''

Everything else you need to know will be on the screen from that point on, including topics covered above such as suggested php.ini and .htaccess settings, access permissions requirements, etc.

= Upgrading =
{{Infobox|'''Always''' make a backup of your mySQL ccHost database and the files you change before you start the upgrade process. Things go wrong. You have been warned.}}
== Upgrading from 5.0 to higher ==
*Log in to your ccHost installation as an admin
*Unzip the ZIP archive on a local machine
*Delete the '''ccadmin''' directory on your local copy
*Copy the entire structure to your web installation
*Browse '''<you_installation_root>?update=1'''

== Upgrading to 5.x from 3.1 and Above ==
===Before you upgrade===
==== Plugins ====
It is recommended that you do '''not''' copy any plugins or custom code that have not been ported to ccHost 5 during the initial upgrade. You should get your site up and running without them using the standard upgrade first, then start migrating your plugins.
==== Importing phpTAL Templates ====
None of your previous version skins, pages, etc. work anymore as is. You can try to import your old phpTAL XML templates using:

bin/cc-host-import-v4-template.php

Many imported templates (like your home page) might "just work" but many will need tweaking, assuming you are familiar with PHP. A detailed description of what might go wrong is [[Preparing_for_ccHost_5.0|this document]].

===Doing the upgrade===
* Log in as admin on your ccHost installation
* Make a backup of your database.
* Unzip the ccHost package on a local machine.
* Copy the entire tree (including ccadmin) to your installation
* Browse to <nowiki>http://<your_install_location</nowiki>

== Upgrading to 5 from 3.0 or Before ==
Upgrading to 5 simply hasn't been tried or tested. (If you have some experience, please feel to share with the rest of the class.) It is therefore not recommended except for the very strong willed.

Instead what you may want to consider (if you don't have a lot of content data) is start with a brand new installation using version 5.

Cchost/guide/Troubleshooting

2009-06-12T18:39:47Z

Fourstones: /* Blank Screen On Upload */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
= Known Issues =
Please consult our [http://sourceforge.net/tracker/?func=browse&group_id=80503&atid=559966&status=1&category=751589 bug tracker] for the latest list of unresolved issues.
= Blank Screen On Upload =
PHP is notorious for returning a completely blank screen when uploading a file fails under some circumstances. Unfortunately those circumstances are hard to track down because of this lack of error reporting.

The most common reasons have to do with [[CcHost_File_Access|file access conflicts]] in Apache as well as memory allocation and other settings in your PHP configuration.

For ccHost 5.1 you can check your installation by clicking on ''Global Settings'' then ''Check PHP Settings'' (or browsing to '''/ini_settings''').

Otherwise these settings should be sufficient:

*file_uploads '''On (1)'''
*upload_max_filesize '''10M'''
*post_max_size '''10M'''
*memory_limit '''10M'''
*max_execution_time '''120'''
*max_input_time '''-1'''

If you are still having problems, to make sure that uploading works on your installation, copy the following code to test_upload.php in your root installation and browse to ''/test_upload.php'' :

<nowiki> <html>
<body>
<?
error_reporting(E_ALL);
upload_file();
print_form();

function print_form()
{
?>
<form enctype="multipart/form-data" action="test_upload.php" method="POST">
File: <input name="uploadedfile" type="file" /><br />
<input type="submit" value="Upload File" />
</form>
<?
}

function upload_file()
{
if( empty($_FILES) )
{
echo "No files to upload";
return;
}

$target_path = "</nowiki>'''content/admin/'''<nowiki>" . basename( $_FILES['uploadedfile']['name']);

if(move_uploaded_file($_FILES['uploadedfile']['tmp_name'], $target_path)) {
echo "The file ". basename( $_FILES['uploadedfile']['name']).
" has been uploaded ";
echo "<a href=\"" . $target_path . "\">download</a>";
} else{
echo "There was an error uploading the file, please try again!";
}
}

?>
</body>
</html></nowiki>

{{Infobox|Note that the code above assumes your content upload directory is called '''content''' and that you have a user called '''admin'''. Edit the code above to conform to your installation if these assumptions are not correct.}}

If the upload did ''not'' succeed then the problem is definitely in your operating system or PHP environment and not in ccHost.

If the upload did succeed there might be a problem with your getID3 installation. To test that possibility you'll need to edit a file within the ccHost installation called '''cchost_lib/cc-fileveryify.php''' In that file at about line 143 there is a line of code that looks like:

<nowiki>CCDebug::QuietErrors();
</nowiki>

You'll want to put two forward slashes in front of that line so it looks like this:

<nowiki>// CCDebug::QuietErrors();</nowiki>

A few lines later do the same thing to the ''RestoreErrors'' calls so it looks like:

<nowiki>// CCDebug::RestoreErrors();
</nowiki>

Now try your upload using the ccHost submit forms. If there is a problem with your getID3 installation, then the errors should lead you to what the solution is.

{{Infobox|Once you have diagnosed the problem, make sure to return the PHP file you edited back to its original version for production sites!!}}

= IE8 Layout Issues =
Some of the screens in some of the skins are problematic for Internet Explorer 8.

The easy way to prevent these problems is to force "compatibility" mode using a meta tag in the skin.

To do this:

# Browse to admin/templatetags/profiles
# For the '''%(extra-meta)%''' field enter the following:

<nowiki><meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" /></nowiki>

If you don't see an 'extra-meta' field you can add one:

# Browse to admin/templatetags/new
# Type '''extra-meta''' into the field and submit

That should return you to the template tags editing screen where you can add the meta tag above.

= 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|ccHost file access guildlines]].
= No Flash Player (little speaker) for Audio Files =
If you uploaded an audio file and expected a little speaker icon and the Flash (tm) player but don't see that it could be one of several things:

- The Flash(tm) will not show up on a page unless you have chosen the "Text appropriate for music sites" string profile, or one that derives from it, from '''admin/skins/settings''' screen. (This is a design flaw we will be addressing in the not-so-distant future.)

- Older versions of Flash only support MP3s and only those that are encoded with a sample rate divisible by 11 like 44k.

- You don't have a working Flash(tm) plugin installed in your browser.

= 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 <nowiki><your_local_files>/lib/DEBUG.php</nowiki>. 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:

<nowiki><your_installation_root>?dump_page=1</nowiki>

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:

<nowiki><your_installation_root>?dump_rec=1</nowiki>

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

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

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:

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

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

Cchost/guide/Customize

2009-06-12T18:35:06Z

Fourstones: /* Admin Customizations */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
==Overview==
There are many levels of customization to a ccHost installation with each level requiring more and more technical skill. It is not obvious what kind of customization is possible at each level so here are some hints that might help you to decide what you need to do in order to achieve your goals.

==Admin Customizations==
In ccHost 5 there are dozens of customizations that do not require any coding. You can do all these simply by filling out forms:
*Customize your [[Cchost/customize/Home_Page|home page]]
* Using the [[Cchost/customize/News_Feature|'News' feature]] in the sidebar or your home page.
*Notify your users of outages and other site news [[Cchost/admin/Basic_HOWTOs#What.27s_a_.27Blurb.27_and_How_Do_I_Use_It.3F|using 'Blurbs']]
*Create and manage [[cchost/admin/Content_Manager|formatted content pages]]
*Upload [[cchost/admin/Basic HOWTOs##How_do_I_change_the_banner_.28logo.29.3F|banner images (logos)]]
*Customize [[Cchost/admin/config_customize#Strings|the text]] (menus, prompts, labels, etc.)
*Manage [[Cchost/admin/License|licenses]]
*Create your own submit form types
*[[Cchost/admin/config_customize#Page_Layout|Page layouts]] (e.g. placement of menus, tabs, widgets, etc.)
*Select default font family and size from a list.
*Select [[Cchost/admin/config_customize#Colors|color schemes]].
*Select and order [[Cchost/admin/config_customize#Sidebar_extras|sidebar extras]] (aka widgets)
*Select how your forms are laid out from a list of available layouts.
*Save and retrieve multiple versions of [[Cchost/concepts/Skins#Create_a_Skin_Profile|skin profiles]]
*Create '[[Cchost/concepts/Virtual_Roots|mini sites]]' with different look and feel for each one
*[[Cchost/admin/Basic_HOWTOs#How_do_I_add_new_file_types_to_the_system.3F|Add file types]] to the system
*Select [[Cchost/How_Content_is_Displayed#Upload_Listings|user content listing types]] from a list of options
*Configure the [[Cchost/How_Content_is_Displayed#Query_Browser|query browser]]

For more options see [[cchost/admin/Basic HOWTOs|Basic HOWTOs]].

==Query Customizations==
All user content (uploads, topics, reviews, etc.) is display via the [[cchost/concepts/Query_Engine|Query API]]. With a little knowledge of URL building you gain control over what uploaded content is displayed in the settings of your choice. For example if you want to show the most popular uploads tagged 'remix' for the last two weeks you specify that using URL syntax in a navigation tab, including the title to display:

tags=remix&sinced=2 weeks ago&sort=rankings&title=Hot Remixes

The query engine also works with topic contents.

==Configuration Customizations==
The way the system is set up, ''all'' of the customizations in the 'Admin' section above are actually fancy ways of manipulating configuration files already in your system, many of which can be superseded by simply making your own version.

Even if you don't exactly know what the configuration syntax is or how it works, you can easily customize your installation with some judicious cut and paste in configuration files that the system will look for in your <local_files> directory. These include:
*How to [[cchost/admin/config_customize#Strings|replace strings]] in forms, prompts and listings.
*Create your own [[cchost/admin/config_customize#Colors|custom color scheme]].
*Create specialized [[cchost/admin/config_customize#Sidebar_extras|sidebar widgets]].

==HTML/CSS Markup Customization==
If you are comfortable with a little HTML and CSS hacking and you still want more control over your installation then you will find quite a large world open up to you.

===Custom Pieces===
If you are generally happy with the overall look and layout of the site but want to change specific screen, you can create customized display layouts and then select them through the admin screens:

*[[cchost/Custom_Query_Templates|Custom query templates]] (way more powerful than you might first realize)
*[[cchost/Static_HTML_Pages|Static HTML]] (and PHP) pages
*[[cchost/How_Content_is_Displayed#Upload Page|Upload page]]
*[[cchost/How_Content_is_Displayed#Upload Listings|Upload listings]]
*[[cchost/How_Content_is_Displayed#Query Browser|Query browser listing]]
*Form layouts

===Custom Skins===
Creating your own skin is how you take ultimate control of the overall look and feel of your installation. Learn how this is done in the [[cchost/concepts/Skins|Skins section]].

==Developer Customizations==
===Common===
There are many customizations that can be done with just a few lines of code. Some of those the more popular ones are:
*[[cchost/developer/customize#Add_or_remove_form_fields|Add or remove form fields]] including the submit forms
*Add data fields [[cchost/developer/customize#Add_data_per_user|per user]] and [[cchost/developer/customize#Add_data_per_upload|per upload]].
*[[Cchost/developer/customize#Using_custom_data_in_a_template|Retrieving custom data]] for listing display in a template
*Saving and retrieving [[Cchost/developer/customize#Saving_and_retrieving_system_configuration_data|data from the system configuration]]
*[[Cchost/developer/customize#Adding_settings_to_the_admin_menus|Adding an admin setting]] to settings menu
*[[Cchost/developer/customize#Mapping_URLs_to_custom_code|Mapping a URL]] to your custom code

===Event Hooking===
ccHost triggers events at certain key moments and you can register to be notified at those times. The more popular ones of those are:
*On [[cchost/developer/tutorial/Hooking_File_Events|file uploaded or deleted]].
*On display of [[Cchost/developer/Hooking_the_User_Profile|user profile]].
*When the remix sources for an upload has changed
*When a new topic has been added or deleted
*When a [[Cchost/Developers#Wait_for_Initialization|session is starting]].
*On [[cchost/developer/Hooking Page Render|every page render]].
*Several different phases of a form being constructed (this applies to every single form in the system)

===Esoteric===
There are many other hooks in the system (over 100) many of which still fall in the category of "easy to hook" even if the hook itself may or may not require heavy lifting. These include:
*Adding % macros that expand on file renaming and ID3 tagging
*Adding and verifying new parameters to the query engine
*[[cchost/developer/tutorial/Replacing the File Verifier|Replacing the file verifier]]
*Adding a new search type

Cchost/admin/Basic HOWTOs

2009-06-12T18:32:44Z

Fourstones: /* What's a 'Blurb' and How Do I Use It? */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}

=How do I change the banner (logo)?=
*Log in as an administrator
*Click on ''Manage Site'' then ''Banner Logo'' (or browse to '''admin/templatetags/bannerlogo''')
*Click on the "Browse" button and select your preferred image.
*Click on the ''Submit Banner Logo'' button

=How do I add new file types to the system?=
*Log in as an administrator (if not already)
*Click on ''Global Settings'' then ''Pseudo Verify'' (or browse to '''admin/pverify''')
*Follow the instructions at the top of the screen
*When you finished click on the ''Submit'' button
*Follow the instructions directly below to enable the file type in submit forms.

=How do I enable/restrict file types users can upload?=
*Log in as an administrator (if not already)
*Click on ''Mangage Site'' then ''File Formats'' (or browse to '''admin/formats''')
*Check the boxes for the formats you want to allow
*Click on the ''Submit'' button

=How do I restrict licenses?=
*Log in as an administrator (if not already)
*Click on ''Manage Site'' then ''License'' (or browse to '''admin/license''')
*Check the licenses you want to enable in submit forms
*Click on the ''Submit'' button
For information on the Creative Commons Licenses see: http://creativecommons.org/licenses/

=How do I add administrators?=
*Log in as an administrator (if not already)
*Click on ''Manage Site'' then ''Settings'' (or browse to '''admin/settings''')
*At the ''Site Administrators'' field, enter a comma separated list of log in names. (If the user name is not in use yet, the next user that registers with that name will become an admin)
*Click on the ''Submit'' button
=What's a 'Blurb' and How Do I Use It?=
A blurb is simply some message you want to convey to visitors of your site. This can be useful for announcing special promotions on the site or future site outages.

You edit and use them exactly the same way you use the [[Cchost/customize/News_Feature|'News' feature]] except you substitute the word 'blurb' for 'news' in that tutorial.

The difference is that registered users can turn the 'News' feature off through the ''Preferences'' menu item, whereas only admins control the 'blurbs' widget.

=How do I edit the navigation tabs at the top of the page?=
Read [[cchost/customize/Navigation Tabs|all about navigation tabs]].

=How do I manage page and topic content in ccHost?=

For the complete howto, see [[cchost/admin/Content_Manager|Content Manager Howto]].

=How do I repair a broken configruation (A.K.A. HELP!!!!)=
See [[Cchost/guide/Troubleshooting#Repairing_a_broken_configuration_.28A.K.A._HELP.21.21.21.21.29|Troubleshooting]].

Cchost/admin/Basic HOWTOs

2009-06-12T18:30:25Z

Fourstones: /* How do I add administrators? */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}

=How do I change the banner (logo)?=
*Log in as an administrator
*Click on ''Manage Site'' then ''Banner Logo'' (or browse to '''admin/templatetags/bannerlogo''')
*Click on the "Browse" button and select your preferred image.
*Click on the ''Submit Banner Logo'' button

=How do I add new file types to the system?=
*Log in as an administrator (if not already)
*Click on ''Global Settings'' then ''Pseudo Verify'' (or browse to '''admin/pverify''')
*Follow the instructions at the top of the screen
*When you finished click on the ''Submit'' button
*Follow the instructions directly below to enable the file type in submit forms.

=How do I enable/restrict file types users can upload?=
*Log in as an administrator (if not already)
*Click on ''Mangage Site'' then ''File Formats'' (or browse to '''admin/formats''')
*Check the boxes for the formats you want to allow
*Click on the ''Submit'' button

=How do I restrict licenses?=
*Log in as an administrator (if not already)
*Click on ''Manage Site'' then ''License'' (or browse to '''admin/license''')
*Check the licenses you want to enable in submit forms
*Click on the ''Submit'' button
For information on the Creative Commons Licenses see: http://creativecommons.org/licenses/

=How do I add administrators?=
*Log in as an administrator (if not already)
*Click on ''Manage Site'' then ''Settings'' (or browse to '''admin/settings''')
*At the ''Site Administrators'' field, enter a comma separated list of log in names. (If the user name is not in use yet, the next user that registers with that name will become an admin)
*Click on the ''Submit'' button
=What's a 'Blurb' and How Do I Use It?=
A blurb is simply some message you want to convey to visitors to your site. You edit and use them exactly the same way you use the [[Cchost/customize/News_Feature|'News' feature]].

The difference is that registered users can turn the 'News' feature off through the ''Preferences'' menu item. Whereas only admins control the 'blurbs' widget. This can be useful for announcing special promotions on the site or future site outages.

=How do I edit the navigation tabs at the top of the page?=
Read [[cchost/customize/Navigation Tabs|all about navigation tabs]].

=How do I manage page and topic content in ccHost?=

For the complete howto, see [[cchost/admin/Content_Manager|Content Manager Howto]].

=How do I repair a broken configruation (A.K.A. HELP!!!!)=
See [[Cchost/guide/Troubleshooting#Repairing_a_broken_configuration_.28A.K.A._HELP.21.21.21.21.29|Troubleshooting]].

Cchost/customize/News Feature

2009-06-12T18:25:21Z

Fourstones: /* Using 'News' Embedded in Your Home Page */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{cchost_5_1}}
{{lowercase}}
= To Create New 'News' Topics =
The "News" feature is a sidebar widget you can use to keep your users informed of latest happenings on your site.

#Log in as administrator (if not already)
#Click on ''Global Settings'' then ''Manage Page Content'' (or browse to '''admin/content''')
#Click on the ''Create New Content'' button
#Select 'news' from the ''Content Type'' field and leave ''New Content Type'' blank. (If you do not see 'news' as an option, then type ''news'' into the ''New Content Type'' field.)
#Fill out the ''Title'' and ''Content Entry'' fields and click the ''Submit Content'' button

This last step will take you back to the ''Manage Page Content'' screen. Select 'news' from the ''Select topic type'' list and you should see your new topic at the top of the list of topics.

= Add/Remove 'News' as a Sidebar Widget =
#Log in as administrator (if not already)
#Click on ''Manage Site'' then ''Sidebar Extras'' (or browse to '''admin/extras''')
#If the 'News' box is not already in the sidebar, drag it from the center of the screen under ''Available Sidebar Extras'' to the sidebar under ''Sidebar Extras In Use / Drag items to here...''
#Click on the ''Save'' button.

To remove the 'News' feature from the sidebar, drag it from the sidebar back into the center of the screen.

=Using 'News' Embedded in Your Home Page=
Follow the steps to editing your home page topics as [[Cchost/customize/Home_Page|discussed here]].

While editing any of your home page topics and in the ''Content Entry'' field, put the following line:

<nowiki>[query=t=news&type=news&limit=4][/query]</nowiki>

This will embed the latest 4 topics directly into your home page.

Cchost/customize/News Feature

2009-06-12T18:24:32Z

Fourstones:

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{cchost_5_1}}
{{lowercase}}
= To Create New 'News' Topics =
The "News" feature is a sidebar widget you can use to keep your users informed of latest happenings on your site.

#Log in as administrator (if not already)
#Click on ''Global Settings'' then ''Manage Page Content'' (or browse to '''admin/content''')
#Click on the ''Create New Content'' button
#Select 'news' from the ''Content Type'' field and leave ''New Content Type'' blank. (If you do not see 'news' as an option, then type ''news'' into the ''New Content Type'' field.)
#Fill out the ''Title'' and ''Content Entry'' fields and click the ''Submit Content'' button

This last step will take you back to the ''Manage Page Content'' screen. Select 'news' from the ''Select topic type'' list and you should see your new topic at the top of the list of topics.

= Add/Remove 'News' as a Sidebar Widget =
#Log in as administrator (if not already)
#Click on ''Manage Site'' then ''Sidebar Extras'' (or browse to '''admin/extras''')
#If the 'News' box is not already in the sidebar, drag it from the center of the screen under ''Available Sidebar Extras'' to the sidebar under ''Sidebar Extras In Use / Drag items to here...''
#Click on the ''Save'' button.

To remove the 'News' feature from the sidebar, drag it from the sidebar back into the center of the screen.

=Using 'News' Embedded in Your Home Page=
Follow the steps to editing your home page topics is [[Cchost/customize/Home_Page|discussed here]].

Open any of your home page topics and in the ''Content Entry'' field, put the following line:

<nowiki>[query=t=news&type=news&limit=4][/query]</nowiki>

This will embed the latest 4 topics directly into your home page.

Cchost/guide/Customize

2009-06-12T18:19:04Z

Fourstones: /* Admin Customizations */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
==Overview==
There are many levels of customization to a ccHost installation with each level requiring more and more technical skill. It is not obvious what kind of customization is possible at each level so here are some hints that might help you to decide what you need to do in order to achieve your goals.

==Admin Customizations==
In ccHost 5 there are dozens of customizations that do not require any coding. You can do all these simply by filling out forms:
*Customize your [[Cchost/customize/Home_Page|home page]]
* Using the [[Cchost/customize/News_Feature|'News' feature]] in the sidebar or your home page.
*Create and manage [[cchost/admin/Content_Manager|formatted content pages]]
*Upload [[cchost/admin/Basic HOWTOs##How_do_I_change_the_banner_.28logo.29.3F|banner images (logos)]]
*Customize [[Cchost/admin/config_customize#Strings|the text]] (menus, prompts, labels, etc.)
*Manage [[Cchost/admin/License|licenses]]
*Create your own submit form types
*[[Cchost/admin/config_customize#Page_Layout|Page layouts]] (e.g. placement of menus, tabs, widgets, etc.)
*Select default font family and size from a list.
*Select [[Cchost/admin/config_customize#Colors|color schemes]].
*Select and order [[Cchost/admin/config_customize#Sidebar_extras|sidebar extras]] (aka widgets)
*Select how your forms are laid out from a list of available layouts.
*Save and retrieve multiple versions of [[Cchost/concepts/Skins#Create_a_Skin_Profile|skin profiles]]
*Create '[[Cchost/concepts/Virtual_Roots|mini sites]]' with different look and feel for each one
*[[Cchost/admin/Basic_HOWTOs#How_do_I_add_new_file_types_to_the_system.3F|Add file types]] to the system
*Select [[Cchost/How_Content_is_Displayed#Upload_Listings|user content listing types]] from a list of options
*Configure the [[Cchost/How_Content_is_Displayed#Query_Browser|query browser]]

For more options see [[cchost/admin/Basic HOWTOs|Basic HOWTOs]].

==Query Customizations==
All user content (uploads, topics, reviews, etc.) is display via the [[cchost/concepts/Query_Engine|Query API]]. With a little knowledge of URL building you gain control over what uploaded content is displayed in the settings of your choice. For example if you want to show the most popular uploads tagged 'remix' for the last two weeks you specify that using URL syntax in a navigation tab, including the title to display:

tags=remix&sinced=2 weeks ago&sort=rankings&title=Hot Remixes

The query engine also works with topic contents.

==Configuration Customizations==
The way the system is set up, ''all'' of the customizations in the 'Admin' section above are actually fancy ways of manipulating configuration files already in your system, many of which can be superseded by simply making your own version.

Even if you don't exactly know what the configuration syntax is or how it works, you can easily customize your installation with some judicious cut and paste in configuration files that the system will look for in your <local_files> directory. These include:
*How to [[cchost/admin/config_customize#Strings|replace strings]] in forms, prompts and listings.
*Create your own [[cchost/admin/config_customize#Colors|custom color scheme]].
*Create specialized [[cchost/admin/config_customize#Sidebar_extras|sidebar widgets]].

==HTML/CSS Markup Customization==
If you are comfortable with a little HTML and CSS hacking and you still want more control over your installation then you will find quite a large world open up to you.

===Custom Pieces===
If you are generally happy with the overall look and layout of the site but want to change specific screen, you can create customized display layouts and then select them through the admin screens:

*[[cchost/Custom_Query_Templates|Custom query templates]] (way more powerful than you might first realize)
*[[cchost/Static_HTML_Pages|Static HTML]] (and PHP) pages
*[[cchost/How_Content_is_Displayed#Upload Page|Upload page]]
*[[cchost/How_Content_is_Displayed#Upload Listings|Upload listings]]
*[[cchost/How_Content_is_Displayed#Query Browser|Query browser listing]]
*Form layouts

===Custom Skins===
Creating your own skin is how you take ultimate control of the overall look and feel of your installation. Learn how this is done in the [[cchost/concepts/Skins|Skins section]].

==Developer Customizations==
===Common===
There are many customizations that can be done with just a few lines of code. Some of those the more popular ones are:
*[[cchost/developer/customize#Add_or_remove_form_fields|Add or remove form fields]] including the submit forms
*Add data fields [[cchost/developer/customize#Add_data_per_user|per user]] and [[cchost/developer/customize#Add_data_per_upload|per upload]].
*[[Cchost/developer/customize#Using_custom_data_in_a_template|Retrieving custom data]] for listing display in a template
*Saving and retrieving [[Cchost/developer/customize#Saving_and_retrieving_system_configuration_data|data from the system configuration]]
*[[Cchost/developer/customize#Adding_settings_to_the_admin_menus|Adding an admin setting]] to settings menu
*[[Cchost/developer/customize#Mapping_URLs_to_custom_code|Mapping a URL]] to your custom code

===Event Hooking===
ccHost triggers events at certain key moments and you can register to be notified at those times. The more popular ones of those are:
*On [[cchost/developer/tutorial/Hooking_File_Events|file uploaded or deleted]].
*On display of [[Cchost/developer/Hooking_the_User_Profile|user profile]].
*When the remix sources for an upload has changed
*When a new topic has been added or deleted
*When a [[Cchost/Developers#Wait_for_Initialization|session is starting]].
*On [[cchost/developer/Hooking Page Render|every page render]].
*Several different phases of a form being constructed (this applies to every single form in the system)

===Esoteric===
There are many other hooks in the system (over 100) many of which still fall in the category of "easy to hook" even if the hook itself may or may not require heavy lifting. These include:
*Adding % macros that expand on file renaming and ID3 tagging
*Adding and verifying new parameters to the query engine
*[[cchost/developer/tutorial/Replacing the File Verifier|Replacing the file verifier]]
*Adding a new search type

Fourstones: brought this page up to date to represent more current installs

Cchost/guide/Troubleshooting

2009-05-03T19:57:51Z

Fourstones: /* Blank Screen On Upload */

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
= Known Issues =
Please consult our [http://sourceforge.net/tracker/?func=browse&group_id=80503&atid=559966&status=1&category=751589 bug tracker] for the latest list of unresolved issues.
= Blank Screen On Upload =
PHP is notorious for returning a completely blank screen when uploading a file fails under some circumstances. Unfortunately those circumstances are hard to track down because of this lack of error reporting.

The most common reasons have to do with [[CcHost_File_Access|file access conflicts]] in Apache as well as memory allocation and other settings in your PHP configuration.

For ccHost 5.1 (in SVN only as of this writing) you can check your installation by browsing to ''/ini_settings''.

Otherwise these settings should be sufficient:

*file_uploads '''On (1)'''
*upload_max_filesize '''10M'''
*post_max_size '''10M'''
*memory_limit '''10M'''
*max_execution_time '''120'''
*max_input_time '''-1'''

If you are still having problems, to make sure that uploading works on your installation, copy the following code to test_upload.php in your root installation and browse to ''/test_upload.php'' :

<nowiki> <html>
<body>
<?
error_reporting(E_ALL);
upload_file();
print_form();

function print_form()
{
?>
<form enctype="multipart/form-data" action="test_upload.php" method="POST">
File: <input name="uploadedfile" type="file" /><br />
<input type="submit" value="Upload File" />
</form>
<?
}

function upload_file()
{
if( empty($_FILES) )
{
echo "No files to upload";
return;
}

$target_path = "</nowiki>'''content/admin/'''<nowiki>" . basename( $_FILES['uploadedfile']['name']);

if(move_uploaded_file($_FILES['uploadedfile']['tmp_name'], $target_path)) {
echo "The file ". basename( $_FILES['uploadedfile']['name']).
" has been uploaded ";
echo "<a href=\"" . $target_path . "\">download</a>";
} else{
echo "There was an error uploading the file, please try again!";
}
}

?>
</body>
</html></nowiki>

{{Infobox|Note that the code above assumes your content upload directory is called '''content''' and that you have a user called '''admin'''. Edit the code above to conform to your installation if these assumptions are not correct.}}

If the upload did ''not'' succeed then the problem is definitely in your operating system or PHP environment and not in ccHost.

If the upload did succeed there might be a problem with you getID3 installation. To test that possibility you'll need to edit a file within the ccHost installation called '''cchost_lib/cc-fileveryify.php''' In that file at about line 143 there is a line of code that looks like:

<nowiki>CCDebug::QuietErrors();
</nowiki>

You'll want to put two forward slashes in front of that line so it looks like this:

<nowiki>// CCDebug::QuietErrors();</nowiki>

Now try your upload using the ccHost submit forms. If there is a problem with your getID3 installation, then the errors should lead you to what the solution is.

= IE8 Layout Issues =
Some of the screens in some of the skins are problematic for Internet Explorer 8.

The easy way to prevent these problems is to force "compatibility" mode using a meta tag in the skin.

To do this:

# Browse to admin/templatetags/profiles
# For the '''%(extra-meta)%''' field enter the following:

<nowiki><meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" /></nowiki>

= 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|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 <nowiki><your_local_files>/lib/DEBUG.php</nowiki>. 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:

<nowiki><your_installation_root>?dump_page=1</nowiki>

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:

<nowiki><your_installation_root>?dump_rec=1</nowiki>

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

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

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:

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

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

Cchost/guide/Troubleshooting

2009-05-03T19:56:23Z

Fourstones: blank screen on upload

[[Category:ccHost]]
[[Category:ccMixter]]
[[Category:Developer]]
[[Category:Software]]
[[Category:Technology]]
{{cchost_head}}
{{lowercase}}
= Known Issues =
Please consult our [http://sourceforge.net/tracker/?func=browse&group_id=80503&atid=559966&status=1&category=751589 bug tracker] for the latest list of unresolved issues.
= Blank Screen On Upload =
PHP is notorious for returning a completely blank screen when uploading a file fails under some circumstances. Unfortunately those circumstances are hard to track down because of this lack of error reporting.

The most common reasons have to do with [[CcHost_File_Access|file access conflicts]] in Apache as well as memory allocation and other settings in your PHP configuration.

For ccHost 5.1 (in SVN only as of this writing) you can check your installation by browsing to ''/ini_settings''.

Otherwise these settings should be sufficient:

*file_uploads '''On (1)'''
*upload_max_filesize '''10M'''
*post_max_size '''10M'''
*memory_limit '''10M'''
*max_execution_time '''120'''
*max_input_time '''-1'''

If you are still having problems, to make sure that uploading works on your installation, copy the following code to test_upload.php in your root installation and browse to ''/test_upload.php'' :

<nowiki> <html>
<body>
<?
error_reporting(E_ALL);
upload_file();
print_form();

function print_form()
{
?>
<form enctype="multipart/form-data" action="test_upload.php" method="POST">
File: <input name="uploadedfile" type="file" /><br />
<input type="submit" value="Upload File" />
</form>
<?
}

function upload_file()
{
if( empty($_FILES) )
{
echo "No files to upload";
return;
}

$target_path = "</nowiki>'''content/admin/'''<nowiki>" . basename( $_FILES['uploadedfile']['name']);

if(move_uploaded_file($_FILES['uploadedfile']['tmp_name'], $target_path)) {
echo "The file ". basename( $_FILES['uploadedfile']['name']).
" has been uploaded ";
echo "<a href=\"" . $target_path . "\">download</a>";
} else{
echo "There was an error uploading the file, please try again!";
}
}

?>
</body>
</html></nowiki>

{{Infobox|Note that the code above assumes your content upload directory is called '''content''' and that you have a user called '''admin'''. Edit the code above to conform to your installation if these assumptions are not correct.}}

If the upload did ''not'' succeed then the problem is definitely in your operating system or PHP environment and not in ccHost.

If the upload did succeed there might be a problem with you getID3 installation. To test that possibility you'll need to edit a file within the ccHost installation called '''cchost_lib/cc-fileveryify.php''' In that file at about line 143 there is a line of code that looks like:

<nowiki>CCDebug::QuietErrors();
</nowiki>

You'll want to put two forward slashes in front of that line so it looks like this:

<nowiki>// CCDebug::QuietErrors();</nowiki>

If there is a problem with your getID3 installation, then the errors should lead you to what the solution is.

= IE8 Layout Issues =
Some of the screens in some of the skins are problematic for Internet Explorer 8.

The easy way to prevent these problems is to force "compatibility" mode using a meta tag in the skin.

To do this:

# Browse to admin/templatetags/profiles
# For the '''%(extra-meta)%''' field enter the following:

<nowiki><meta http-equiv="X-UA-Compatible" content="IE=EmulateIE7" /></nowiki>

= 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|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 <nowiki><your_local_files>/lib/DEBUG.php</nowiki>. 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:

<nowiki><your_installation_root>?dump_page=1</nowiki>

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:

<nowiki><your_installation_root>?dump_rec=1</nowiki>

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

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

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:

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

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