GeeklogWiki - User contributions [en]

Google Summer of Code

2012-03-09T17:43:21Z

Cordiste: /* Mentors */ Link to cordiste's page

User:Cordiste

2012-03-09T17:41:21Z

Cordiste: New page: Ben aka cordiste Contact: http://geeklog.fr

Ben aka cordiste

Contact: http://geeklog.fr

Multi-Site Setup

2010-11-08T21:43:30Z

Cordiste: /* siteconfig.php */ Allow siteconfig to each site

== What is it? ==

With only a small modification, Geeklog can be used to run several websites off of one code base, i.e. you only need one physical set of files to run more than one Geeklog site.

Please note that this setup does have some drawbacks and limitations (discussed below) and is not officially supported.

== Setting it up ==

Since (almost) all the configuration information is held in the database, we only need to make sure that Geeklog picks the correct database for the site it's supposed to display. The trick is that the global PHP variable <code>$_SERVER['HTTP_HOST']</code> contains, effectively, the domain name that the visitor used to call up the site. So we modify <tt>db-config.php</tt> like so:

<pre>
if (strpos($_SERVER['HTTP_HOST'], 'example.com') !== false) {
$_DB_host = 'localhost';
$_DB_name = 'database1';
$_DB_user = 'dbuser1';
$_DB_pass = 'password1';
$_DB_table_prefix = 'ex1_';
} else {
$_DB_host = 'localhost';
$_DB_name = 'database2';
$_DB_user = 'dbuser2';
$_DB_pass = 'password2';
$_DB_table_prefix = 'ex2_';
}
$_DB_dbms = 'mysql';
</pre>

You can add additional <code>elseif</code> sections for every additional site that you want to support.

=== Tweaks ===
Minor tweaks:
* If all databases are using the same host, you only need to list the <code>$_DB_host</code> variable once.
* If all sites use their own database, they could also all use the same table prefix, which would also be listed only once then.
* If you want to run sites with different DBMS (e.g. one site running on Postgres, while others are on MySQL), you would need to move the <code>$_DB_dbms</code> into the if/else construct.

=== Domain Name ===

Note that we're using <code>strpos</code> to check for the domain name. This is so that we can both accept <tt>www.example.com</tt> and <tt>example.com</tt>.

You may want to set up a <tt>.htaccess</tt> rule so that your site always uses the same form, despite what the user enters. For example, if you prefer the form <tt>www.example.com</tt> over others, you can add

<pre>
RewriteEngine On

RewriteCond %{HTTP_HOST} example.com [NC]
RewriteRule (.*) http://www.example.com/$1 [L,R]
</pre>

to your <tt>.htaccess</tt> to redirect <nowiki>http://example.com/</nowiki> to <nowiki>http://www.example.com/</nowiki>. That redirect happens before the above code in your <tt>db-config.php</tt> is executed, i.e. the code will only see the "www" form then.

=== siteconfig.php ===

As in the db-config.php file, the informations from the <tt>siteconfig.php</tt> file can be different for each site.

<pre>
if ($_SERVER['HTTP_HOST'] == 'example1.com') {
// To disable your site1 quickly, simply set this flag to false
$_CONF['site_enabled'] = true;
$_CONF_FCK['imagelibrary'] = '/images/library_site1';
$_CONF['default_charset'] = 'utf-8';

} else if ($_SERVER['HTTP_HOST'] == 'example2.com) {
// To disable your site2 quickly, simply set this flag to false
$_CONF['site_enabled'] = true;
$_CONF_FCK['imagelibrary'] = '/images/library_site2';
$_CONF['default_charset'] = 'utf-8';

} else if ($_SERVER['HTTP_HOST'] == 'example3.com) {
// To disable your site2 quickly, simply set this flag to false
$_CONF['site_enabled'] = false;
$_CONF_FCK['imagelibrary'] = '/images/library_site3';
$_CONF['default_charset'] = 'utf-8';

}
</pre>

== Limitations and Workarounds ==

The main advantage of this setup is also its main limitation: All the resources are shared between sites. This is what we want for the source code, but it also happens for other files. This can be worked around in some cases but not in all of them.

=== Installation and Upgrades ===

Please note that Geeklog's install script is not aware of this hack and will only be able to install or upgrade one site at a time. This makes upgrades especially awkward, as you have to take all the sites down at the same time and then upgrade them one after the other (using temporary copies of <tt>db-config.php</tt>, since the install script will modify it).

=== Plugins ===

All plugins will be available to all the sites. This does not mean, however, that they need to be installed for all of them. You can install, say, the Forum plugin for one site only. Just keep in mind that it will show up as an uninstalled plugin for all the other sites.

Plugins share all of their files with all of the sites. This may cause problems when the plugin stores files in fixed locations (e.g. configuration information that needs to be different for different sites).

==== sitemap.xml ====

Of the plugins that ship with Geeklog, the [[XMLSitemap Plugin]] needs a special setup: The default name for the sitemap file is <tt>sitemap.xml</tt> and would be used by all the sites which would obviously cause confusion. Go to the XMLSitemap section in the Configuration and make sure you use a different file name for each site.

Note that due to the fact that all your sites share a single [[Multi-Site Setup#robots.txt|robots.txt]] you can ''not'' add the sitemaps to your <tt>robots.txt</tt> file. Instead, you will have to submit them manually for each site, e.g. via the [https://www.google.com/webmasters/tools/ Google Webmaster Tools].

=== Themes ===

Like any other resource, all themes are also available for each site. This may not be a problem if you're using a distinct theme for each site anyway and don't let your users change their theme. Otherwise, you may need to change the [http://www.geeklog.net/docs/english/config.html#desc_path_themes Themes Path] in the Configuration of each site.

==== Favicon ====

Related to the theme: You probably want to use different [http://en.wikipedia.org/wiki/Favicon Favicons] for your sites. Since some browsers are looking for a file called <tt>favicon.ico</tt> by default, you should make sure ''not'' to have a file of that name. Instead, modify the <tt>header.thtml</tt> of your site's theme to point to a favicon with a unique name:

<pre>
<link rel="SHORTCUT ICON" href="{site_url}/mysite.ico">
</pre>

=== Images ===

Geeklog's <tt>images</tt> directory is shared. This may cause problems especially with the user photos (if you allow those). You can disable uploading of user photos and/or switch to using [http://www.geeklog.net/docs/english/config.html#desc_use_gravatar Gravatar].

As long as you make sure not to re-use story IDs, all article images could be left in the same directory. If you can not guarantee that, you may want to separate the images directories (again, in the Configuration). Please note that this will also affect user photos and topic icons.

=== robots.txt ===

The <tt>robots.txt</tt> has a fixed file name and will have to be shared between all sites. Keep that in mind when adding entries.

(In theory, it should be possible to set up the server to create the <tt>robots.txt</tt> dynamically. Not sure if that's worth the effort and it will most likely affect all <tt>.txt</tt> files on the server.)

=== .htaccess ===

Unless you can tweak you webserver's setup, the <tt>.htaccess</tt> will also have to be shared between sites. Keep that in mind when adding redirects or deny rules.

Google Code-in

2010-10-29T07:22:08Z

Cordiste: /* Update plugins list */

= Information for students =

This is a collection of ''possible'' tasks for the [http://code.google.com/opensource/gci/2010-11/ Google Code-in]. Please note that you can '''not''' claim these tasks from here. Should Geeklog be accepted as a mentoring organization, you will be able to claim tasks from the Code-in homepage, once the contest starts.

For more information, please see the [http://code.google.com/opensource/gci/2010-11/faqs.html Google Code-in FAQ].

= Tasks =

== Move the FAQ to the wiki ==

Description: The [http://www.geeklog.net/faqman/ Geeklog FAQ] is hard to maintain in its current state (due to technical issues with the FAQ plugin and the fact that contributions can't be included easily). So the idea is to move all the current FAQ topics to the [http://wiki.geeklog.net/ Geeklog Wiki]. Hints: One wiki page per FAQ article. Add a FAQ category. Make sure the formatting, e.g. of sample code, is carried over.
 Category: Documentation
 Difficulty: easy
 Time: a few hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== FAQ: Fix occurences of config.php ==

Description: There are a lot of places in the [http://www.geeklog.net/faqman/ Geeklog FAQ] that still refer to the <tt>config.php</tt> that was used for configuration in earlier Geeklog versions. Find and rewrite those sections to refer to the Configuration Admin panel instead. Note: Some occurences may still be valid (e.g. when referring to upgrading from an old version) or may need to refer to the <tt>siteconfig.php</tt> or <tt>db-config.php</tt> file now instead.
 Category: Documentation
 Difficulty: easy
 Time: 1-2 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Review the installation instructions ==

Description: Try to install Geeklog following the [http://www.geeklog.net/docs/english/install.html installation instructions]. Make notes of the problems you have ''understanding'' these instructions. Suggest a list of improvements.
 Category: Documentation
 Difficulty: easy
 Time: 1-2 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Review the installation instructions ==

Description: Try to install Geeklog following the [http://www.geeklog.net/docs/english/install.html installation instructions]. Make notes of the problems you run into ''following'' these instructions. Check that the troubleshooting section covers these problems. If not, suggest additions.
 Category: Documentation
 Difficulty: easy
 Time: 1-2 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Find a replacement for kses ==

Description: Geeklog uses [http://sourceforge.net/projects/kses/ kses] as its HTML filter. Since kses is no longer supported, we are looking for a replacement. Research other existing HTML filters and evaluate them. Check features such as filtering abilities (HTML tags + attributes, JavaScript, CSS), ability to close unbalanced HTML tags. Also consider dependency on any frameworks / libraries, ongoing support, and a GPLv2-compatible license.
 Category: Research
 Difficulty: medium
 Time: about 8 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Provide a translation for a plugin ==

Description: Geeklog (i.e. the Geeklog Core) has been translated into more than 20 [[What Languages are Available?|languages]]. However, not all of the plugins we ship with Geeklog have been translated to all those languages yet. If you speak one of those languages, [[Translations|provide a missing translation]]. (To do: make a full list of the missing translations; this should easily account for 20+ tasks)
 Category: Translation
 Difficulty: medium
 Time: about 4-6 hours each
 Possible Mentors: preferrably people speaking the language ...

== Update a Geeklog (Core) translation ==

Description: Geeklog (i.e. the Geeklog Core) has been translated into more than 20 [[What Languages are Available?|languages]]. However, not all of the Core language files are actively maintained, so some of them are only partially translated. If you speak one of those languages, [[Translations|update one of those translations]]. (To do: make a full list of the affected translations; this should account for another 10+ tasks)
 Category: Translation
 Difficulty: medium
 Time: about 4-6 hours each
 Possible Mentors: preferrably people speaking the language ...

== Create a "Invitation to contribute" page ==

Description: When you click to download OpenOffice.org, you are taken to [http://download.openoffice.org/contribute.html this page] that explains how you can contribute to OOo. Design a similar page for Geeklog.
 Category: Outreach
 Difficulty: medium
 Time: about 4 hours
 Possible Mentor: ???

== Design a flyer ==

Description: Design a flyer / handout (for inspiration, here's an [http://www.geeklog.net/filemgmt/index.php?id=711 old flyer] and a [http://geeklog.info/filemgmt/index.php?id=170 poster] that can also be used as a flyer). Refer to the [http://www.geeklog.net/docs/english/ Geeklog Documentation] for a list of features.
 Category: Outreach
 Difficulty: medium
 Time: about 8-12 hours
 Possible Mentor: ???

== Update plugins list ==

Description: Update the [[Unofficial_Plugins|plugins list]] and give some basic informations for each one (Description, last available version, last release date, link to support or contact).
 Category: Research
 Difficulty: medium
 Time: about 8-12 hours
 Possible Mentor: ???

= TBD =

More programming tasks can be lifted from the bugtracker:
* issues labelled "beginner"
* issues that have a patch attached: try out the patch

Possible categories: Code, documentation, outreach, QA, research, training, translation, user interface

Google Code-in

2010-10-29T07:19:50Z

Cordiste: Create task : Update plugins list

= Information for students =

This is a collection of ''possible'' tasks for the [http://code.google.com/opensource/gci/2010-11/ Google Code-in]. Please note that you can '''not''' claim these tasks from here. Should Geeklog be accepted as a mentoring organization, you will be able to claim tasks from the Code-in homepage, once the contest starts.

For more information, please see the [http://code.google.com/opensource/gci/2010-11/faqs.html Google Code-in FAQ].

= Tasks =

== Move the FAQ to the wiki ==

Description: The [http://www.geeklog.net/faqman/ Geeklog FAQ] is hard to maintain in its current state (due to technical issues with the FAQ plugin and the fact that contributions can't be included easily). So the idea is to move all the current FAQ topics to the [http://wiki.geeklog.net/ Geeklog Wiki]. Hints: One wiki page per FAQ article. Add a FAQ category. Make sure the formatting, e.g. of sample code, is carried over.
 Category: Documentation
 Difficulty: easy
 Time: a few hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== FAQ: Fix occurences of config.php ==

Description: There are a lot of places in the [http://www.geeklog.net/faqman/ Geeklog FAQ] that still refer to the <tt>config.php</tt> that was used for configuration in earlier Geeklog versions. Find and rewrite those sections to refer to the Configuration Admin panel instead. Note: Some occurences may still be valid (e.g. when referring to upgrading from an old version) or may need to refer to the <tt>siteconfig.php</tt> or <tt>db-config.php</tt> file now instead.
 Category: Documentation
 Difficulty: easy
 Time: 1-2 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Review the installation instructions ==

Description: Try to install Geeklog following the [http://www.geeklog.net/docs/english/install.html installation instructions]. Make notes of the problems you have ''understanding'' these instructions. Suggest a list of improvements.
 Category: Documentation
 Difficulty: easy
 Time: 1-2 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Review the installation instructions ==

Description: Try to install Geeklog following the [http://www.geeklog.net/docs/english/install.html installation instructions]. Make notes of the problems you run into ''following'' these instructions. Check that the troubleshooting section covers these problems. If not, suggest additions.
 Category: Documentation
 Difficulty: easy
 Time: 1-2 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Find a replacement for kses ==

Description: Geeklog uses [http://sourceforge.net/projects/kses/ kses] as its HTML filter. Since kses is no longer supported, we are looking for a replacement. Research other existing HTML filters and evaluate them. Check features such as filtering abilities (HTML tags + attributes, JavaScript, CSS), ability to close unbalanced HTML tags. Also consider dependency on any frameworks / libraries, ongoing support, and a GPLv2-compatible license.
 Category: Research
 Difficulty: medium
 Time: about 8 hours
 Possible Mentor: [[User:Dirk|Dirk Haun]]

== Provide a translation for a plugin ==

Description: Geeklog (i.e. the Geeklog Core) has been translated into more than 20 [[What Languages are Available?|languages]]. However, not all of the plugins we ship with Geeklog have been translated to all those languages yet. If you speak one of those languages, [[Translations|provide a missing translation]]. (To do: make a full list of the missing translations; this should easily account for 20+ tasks)
 Category: Translation
 Difficulty: medium
 Time: about 4-6 hours each
 Possible Mentors: preferrably people speaking the language ...

== Update a Geeklog (Core) translation ==

Description: Geeklog (i.e. the Geeklog Core) has been translated into more than 20 [[What Languages are Available?|languages]]. However, not all of the Core language files are actively maintained, so some of them are only partially translated. If you speak one of those languages, [[Translations|update one of those translations]]. (To do: make a full list of the affected translations; this should account for another 10+ tasks)
 Category: Translation
 Difficulty: medium
 Time: about 4-6 hours each
 Possible Mentors: preferrably people speaking the language ...

== Create a "Invitation to contribute" page ==

Description: When you click to download OpenOffice.org, you are taken to [http://download.openoffice.org/contribute.html this page] that explains how you can contribute to OOo. Design a similar page for Geeklog.
 Category: Outreach
 Difficulty: medium
 Time: about 4 hours
 Possible Mentor: ???

== Design a flyer ==

Description: Design a flyer / handout (for inspiration, here's an [http://www.geeklog.net/filemgmt/index.php?id=711 old flyer] and a [http://geeklog.info/filemgmt/index.php?id=170 poster] that can also be used as a flyer). Refer to the [http://www.geeklog.net/docs/english/ Geeklog Documentation] for a list of features.
 Category: Outreach
 Difficulty: medium
 Time: about 8-12 hours
 Possible Mentor: ???

== Update plugins list ==

Description: Update the plugins list and give some basic informations for each one (Description, last available version, last release date, link to support or contact).
 Category: Research
 Difficulty: medium
 Time: about 8-12 hours
 Possible Mentor: ???

= TBD =

More programming tasks can be lifted from the bugtracker:
* issues labelled "beginner"
* issues that have a patch attached: try out the patch

Possible categories: Code, documentation, outreach, QA, research, training, translation, user interface

Adding Moderation Capability

2010-03-31T17:28:33Z

Cordiste: Move explanations into the right paragraphs

This section will describe and document how to enable your plugin to use the Geeklog moderation engine.

==Note==
This set of functions is optional when creating your plugin, but should be used when your plugin has functionality that includes submitting of an item that needs to be reviewed by a site admin or plugin admin before posting to the site. The Geeklog (GL) developers have made the implementation of this API very straight forward and enabled the API calls into the moderation related
core programs.

===Version note===
You will need to be using Geeklog version 1.3.7 or apply the
changes noted in the appendix to successfully use the Moderation API's, though some functionality may work with previous versions of Geeklog. The changes with 1.3.7 release include the following programs: moderation.php, submit.php, plugin.class.php and lib-plugins.php.
Refer to the appendix if you have a previous release and want to review the needed changes.

==The functions==
There are six (6) plugin functions that are required for the moderation plugin and two (2) optional functions. The example functions that are provided can be used as guide, but they will required some changes to make them work for your plugin.

The following table summarizes the functions:

{|cellPadding="2" width="100%" border="1"
!width=4%|
!Function
!Description of Function
|-
|1
|[[#plugin_ismoderator_<plugin name>|plugin_ismoderator_<plugin name>]]
|Checks if the current user has rights to moderate for the plugin and returns true if this is the case, false otherwise.

|-
|2
|[[#plugin_submissioncount_<plugin name>|plugin_submissioncount_<plugin name>]]
|Calculates the current number of submissions awaiting moderation and returns that number.

|-
|3
|[[#plugin_savesubmission_<plugin name>|plugin_savesubmission_<plugin name>]]
|Takes the data input by the plugin submission form and populates the <plugin name> submission table with that data.

|-
|4
|[[#plugin_moderationvalues_<plugin name>|plugin_moderationvalues_<plugin name>]]
|Returns a list of important moderation values. The list contains (in order): the row 'id' label, the main plugin table name, comma separated string of moderation fields, and the plugin submission table name.

|-
|5
|[[#plugin_itemlist_<plugin name>|plugin_itemlist_<plugin name>]]
|Uses the plugin class to return data required by moderation.php to list plugin objects that need to be moderated.

|-
|6
|[[#plugin_submit_<plugin name>|plugin_submit_<plugin name>]]
|Returns a string containing the HTML to display the plugin submission form.

|-
|7
|[[#plugin_moderationapprove_<plugin name>|plugin_moderationapprove_<plugin name>]]
|This optional function supplements moderation.php. While moderation.php actually moves data from the <plugin name> submission table to the main <plugin name> table, this function executes all other submission approval tasks including any other database updates required by your plugin.

|-
|8
|[[#plugin_moderationdelete_<plugin name>|plugin_moderationdelete_<plugin name>]]
|This optional function supplements moderation.php. While moderation.php actually removes data from the <plugin name> submission table, this function executes all other submission removal tasks including any other database updates required by your plugin.
|}

=== How to call the Moderation Engine ===

After you implement the moderation functions in your plugin, you will need to call the Geeklog moderation engine or program to create or moderate the submission. This can be done by adding a link or button which redirects the user to submit.php or moderate.php with the necessary parameters from your plugin.

The example below was used by the Mailing Lists plugin to link to the 'submit new mailing list' page. The link to submit.php needs to be passed with the parameter '''type''' to indicate which plugin's submission form should be displayed. The variable $retval is assigned the formatted link which will be displayed as a link in the plugin display.

<pre>$retval = "<a href='" . $_CONF['site_url'] . "/submit.php?type=lists'>" . $LANG_LISTS['SUBMITLIST'] . "</a>";</pre>

'''Admin interaction with the Moderation Engine:''' Once all the moderation
functions are implemented, the 'Submissions' link in the admin block will include a list of all submissions to be moderated (they can be approved, removed or edited). You must write your own submission edit function located in $_CONF['site_admin_url'] . '/plugins/<plugin name>/<plugin name>.php. It will be passed the http variables id=<item id> and mode=editsubmission.

=== Plugin database changes ===

The table <plugin name> submission must be the name of your submission
table. This table can only contain a proper subset of the columns from the main <plugin name> table. This allows the moderation.php script to
automatically copy those columns from the submission to the main table upon
approval. All data in columns of the submission table that are not in the main table will be lost.

=== Function details and examples ===

This explanation of the plugin moderation API functions will use the Mailing Lists plugin for examples and give a detailed description of each function.

====plugin_ismoderator_<plugin name>====

The '''''plugin_ismoderator''''' function simply returns TRUE if
the current user has moderation privileges for the plugin. In the example
to the right, The mailing lists plugin simply uses the security function
SEC_hasRights to determine if a user has the required rights. The lists.admin permission was installed with the plugin. You could use your own SQL query or some other criteria to determine access rights.

<pre>
function plugin_ismoderator_lists()
{
global $_USER, $_TABLES;

return SEC_hasRights('lists.admin');
}
</pre>

====plugin_submissioncount_<plugin name>====

The '''''plugin_submissioncount''''' function returns the number of
submissions for this plugin that are awaiting moderation. This value is used to indicate the number of waiting submissions in the admin block. A DB_count() on the plugin submission table is usually sufficient for this.

<pre>
function plugin_submissioncount_lists()
{
global $_TABLES;

return DB_count($_TABLES['listssubmission']);
}
</pre>

====plugin_savesubmission_<plugin name>====

The '''''plugin_savesubmission''''' function takes data entered into
the submission form and saves it to the submission table. Optionally, this function can use different logic for an admin or power user as seen in the Mailing Lists Plugin.
In addition to saving the information to the plugin's submission table, it must also check data entered for validity. Upon failure the function should return false or redirect to the submission form. If successful, the function should redirect to a relevant page, or return true. In Geeklog 1.3.7 the plugin API expects the function to do a redirect (COM_refresh()). If it does not, a successful return from the function
will redirect the user back to the Geeklog home page.

<pre>
function plugin_savesubmission_lists($A)
{
global $_TABLES, $_USER, $_CONF;

// check for missing fields
if (empty($A['ml_name']) || empty($A['ml_descr'])) {
return false;
}

if (empty($_USER['uid'])) {
$owner_id = 1;
} else {
$owner_id = $_USER['uid'];
}

if (SEC_hasRights('links.admin')) {
$result = DB_getItem($_TABLES['groups'], '*', "grp_name = 'lists Admin'");
if ($_CONF['listsarchive'] == 'optional') {
$archive = $_CONF['listsarchivedefault'];
} elseif ($_CONF['listsarchive'] == 'no') {
$archive = 0;
} else { // $_CONF['listsarchive'] == 'yes'
$archive = 1;
}
DB_save($_TABLES['lists'], 'ml_id, ml_name, ml_descr, html, archive, owner_id, group_id',
"'" . COM_makeSid() . "', '" . $A['ml_name'] . "', '" . $A['ml_descr']
. "', " . $_CONF['listshtml'] . ", $archive, $owner_id, " . $result['grp_id']);
} elseif ($_CONF['listssubmission'] == 1) {
DB_save($_TABLES['listssubmission'],
'ml_id, ml_name, ml_descr',
"'" . COM_makeSid() . "', '" . $A['ml_name'] . "', '"
. $A['ml_descr'] . "'");
} else {
return false;
}

if (DB_error()) {
return false;
}

return true;
}
</pre>

====plugin_moderationvalues_<plugin name>====

The '''''plugin_moderationvalues''''' function returns important information used by the Plugin API to handle plugin submissions. It must return an array consisting of the main column id (ml_id), the main table name ($_TABLES['lists']), a comma separated list of columns that will be copied from the plugin submission table to the main table (ml_id, ml_name, ml_descr), and the name of the submission table ($_TABLE['listssubmission']). This information is used to automatically
copy information from the plugin submission table to the plugin main table when a submission is approved.

<pre>
function plugin_moderationvalues_lists()
{
global $_TABLES;

return array('ml_id', $_TABLES['lists'], 'ml_id, ml_name, ml_descr', $_TABLES['listssubmission']);
}
</pre>

====plugin_itemlist_<plugin name>====

The function '''''plugin_itemlist''''' returns a Plugin() class containing information that will displayed on the moderation.php page. The following member variables of the Plugin class must be filled out:

* '''submissionlabel:''' The title that indicate the plugin submission section.
* '''getsubmissionsql:''' An SQL query that will select all the data that will be displayed in the plugin submission section. NOTE: one item (the unique id column) must be labeled id ('as id').
* '''addSubmissionHeading():''' This function must be called once for every field besides the one labeled id. The parameter passed should be the column name to be displayed.

<pre>
function plugin_itemlist_lists()
{
global $_TABLES;

if (plugin_ismoderator_lists()) {
$plugin = new Plugin();
$plugin->submissionlabel = 'Mailing List Submissions';
$plugin->getsubmissionssql = SELECT ml_id as id, ml_name, ml_descr FROM
. $_TABLES['listssubmission'];
$plugin->addSubmissionHeading('List Name');
$plugin->addSubmissionHeading('List Description');

return $plugin;
}
}
</pre>

====plugin_submit_<plugin name>====

The function '''''plugin_submit''''' creates HTML that contains the submission form for the plugin. It is recommended to use the Geeklog template functionality as shown here to create the form. See the section of this manual [[Using Templates and Language Files|on templates]] for more information. When creating the form, be sure to include fields for each variable you would like the user to fill along with preview and submit buttons.

<pre>
function plugin_submit_lists()
{
global $_CONF, $LANG12;

if ($_CONF['listssubmission'] == 0 && !SEC_hasRights('lists.admin')) {
return "Submission queue disabled for mailing lists";
}

if ($_POST['mode'] == $LANG12[32]) { // preview
$A = $_POST;
$ml_id = $A['ml_id'];
} else {
$ml_id = COM_makesid();
}

$template = new Template($_CONF['path'] . "plugins/lists/templates/public");
$template->set_file(array('form' => 'submit_form.thtml'));
$template->set_var('site_url', $_CONF['site_url']);
$template->set_var('lang_name', 'List Name');
$template->set_var('ml_name', $A['ml_name']);
$template->set_var('lang_descr', 'Description');
$template->set_var('ml_descr', $A['ml_descr']);
$template->set_var('ml_id', $ml_id);
$template->set_var('lang_preview', $LANG12[32]);
$template->set_var('lang_save', $LANG12[8]);

return $template->parse('output', 'form');
}
</pre>

====plugin_moderationapprove_<plugin name> ====

Although the moderation.php script takes care of the work of actually moving data from the plugin submission table to the main plugin table, often times a plugin requires more to be done to the plugin tables or for other information to be updated. Geeklog provides the function '''''plugin_moderationapprove''''' for these tasks. In the case of the lists plugin, the main plugin table is updated with additional data that it is not desirable for a user to enter. Instead this function takes care of placing that information into the table. As of now the return value for this function is ignored.

<pre>
function plugin_moderationapprove_lists($id)
{
global $_TABLES, $_USER, $_CONF;

$result = DB_query("SELECT * FROM " . $_TABLES['groups']
. " WHERE grp_name = 'lists Admin'");
$group = DB_fetchArray($result);
if ($_CONF['listsarchive'] == 'optional') {
$archive = $_CONF['listsarchivedefault'];
} elseif ($_CONF['listsarchive'] == 'no') {
$archive = 0;
} else { // $_CONF['listsarchive'] == 'yes'
$archive = 1;
}
$sql = "UPDATE " . $_TABLES['lists'] . " SET owner_id = " . $_USER['uid']
. ", group_id = " . $group['grp_id'] . ", html = " . $_CONF['listshtml']
. ", archive = $archive WHERE ml_id = '$id'";
$result = DB_query($sql);

if (DB_error()) {
return 'Error';
}
return '';
}
</pre>

====plugin_moderationdelete_<plugin name>====

Although the moderation.php script takes care of the work of actually removing data from the plugin submission table for a submission deletion, often times a plugin requires more to be done to the plugin tables or for other information to be updated. Geeklog provides the function '''''plugin_moderationdelete''''' for these tasks. In the case of the lists plugin, tables are checked for extraneous data (that should not exist in most cases) and that data is removed if found. As of now the return value for this function is ignored.

<pre>
function plugin_moderationdelete_lists($id)
{
global $_TABLES;

// these tables should not contain any rows with ml_id = $id
// this is done 'just in case'
DB_delete($_TABLES['listsubscriptions'], 'ml_id', $id);
DB_delete($_TABLES['listarchive'], 'ml_id', $id);
DB_delete($_TABLES['listpermissions'], 'ml_id', $id);
}
</pre>

[[Category:Plugin Developers Handbook]] [[Category:Plugin Development]]

Who made Geeklog?

2010-02-24T10:38:19Z

Cordiste: remove aptitude reference and start a developers list

Geeklog was originally used to run the SecurityGeeks and NewsGeeks websites, and has since been released under the GNU General Public License (version 2). It is a bona fide Open Source / Free Software project. The template code Geeklog uses is from PHPLib, however, which is under the LGPL.

Geeklog was originally created by Jason Whittenburg, but like all good open source projects, depends on the community. Geeklog is currently maintained by '''Dirk Haun'''.

== Core developers ==

* Dirk Haun
* Blaine Lang
* Tom
* Sami
* Tim

== Plugins developers ==

* Blaine Lang
* ::Ben aka cordiste

----

Thanks for your continued support, and let us know what we can do to make Geeklog better.

Administration

2009-06-17T20:54:06Z

Cordiste:

#[[Introduction]]
#[[Installation]]
#[[Administration]]
##[[Configuration]]
###[[The Geeklog Configuration File]]
#### (also see [[ConfigFile14|the 1.4 version]] of this page)
###[[Remote Authentication]]
####[[LDAP Remote Authentication]]
####[[OpenID]]
###[[Blocks]]
####[[Official Blocks|Official]]
#####[[Whos Online Block|Who's Online Block]]
#####[[Topics Block]]
#####[[Admins Block]]
#####[[User Settings & User Functions Block]]
#####[[What's New Block]]
#####[[Poll Block]]
#####[[Events Block]]
#####[[Older Stories Block]]
####[[Unofficial Blocks|Unofficial]]
#####[[News Block]]
####[[Block Types]]
###[[Plugins]]
####[[Official Plugins|Bundled Plugins]]
#####[[Calendar Plugin]]
#####[[Links Plugin]]
#####[[Polls Plugin]]
#####[[Static Pages Plugin]]
#####[[Spam-X Plugin]]
#####[[XMLSitemap Plugin]]
####[[Unofficial Plugins|3rd Party Plugins]]
#####[[Ban Plugin]]
#####[[Captcha Plugin]]
#####[[Contacts Plugin]]
#####[[Dokuwiki plugin]]
#####[[External Pages Plugin]]
#####[[FAQ Manager Plugin]]
#####[[File Management Plugin]]
#####[[Forum Plugin]]
#####[[GlinksPlugin]]
#####[[Mediagallery Plugin]]
#####[[Menu Plugin]]
#####[[MultiFAQ Plugin]]
#####[[Net Tools]]
#####[[ThingsToDoPlugin]]
#####[[Visitor Stats Plugin]]
####[[How To Install A Geeklog Plugin]]
###[[Themes]]
####[[Installing Themes]]
####[[Custom Themes]]
####[[Default Themes]]
####[[Other Themes]]
####[[ThemePort|Porting a Theme]]
###[[Hacks]]
####[[Admin Toolbox]]
##[[Daily Administration]]
###[[Users and Groups]]
###[[Adding and Managing Content]]
####[[Content Types]]
#####[[Stories]]
#####[[Links]]
#####[[Events]]
#####[[Polls]]
####[[Topics]]
####[[Editors and Admins]]
####[[Submission Queues]]
####[[Comments]]
###[[Geeklog Permissions]]
###[[Troubleshooting]]
###[[Dealing with Spam]]
##[[HowTo|Quick How-Tos]]
##[[Security Guidelines]]
#[[Users Documentation|User's Documentation]]
#[[Programmers/Developers Documentation]]

[[Geeklog Documentation|Main TOC]] 
[[Complete Table of Contents]]

Unofficial Plugins

2009-05-18T22:03:19Z

Cordiste: start a plugin list

Unofficial Plugins are plugins that are not included in the official release of Geeklog. Some are created by the Geeklog developers, many by other developers for their own needs and contributed back to the project.

== Plugins List ==

=== Analytics ===

=== Archive ===

=== Autosave ===

=== AutoTags ===

=== Bad Behavior2 ===

=== CAPTCHA ===

=== chameleon ===

=== Chatterblock ===

=== Comment Feeds ===

=== dataproxy ===

=== DBman ===

=== DokuWiki ===

=== FAQ ===

=== FAQManager ===

=== MultiFAQ ===

=== FileMgmt ===

=== Forum ===

=== Flickr ===

=== G2Bridge ===

=== glEventMgr ===

=== glMenu ===

=== glMessenger ===

=== glQuiz ===

=== GL Utility ===

=== Geeklog Usage Stats ===

=== Mantis ===

=== Manual Digets ===

=== Media Gallery ===

=== paypal ===

=== phpbbbridge ===

=== tag ===

=== TaskMan ===

=== Technorati ===

=== tkgmaps ===

=== Testimonials ===

=== vthemes ===

=== YouTube ===

If there is a plugin missing that you are running or developed, please add it to the list. Feel free to add any information about the plugin.

[[Category:Plugins]]

Plugins

2009-05-18T21:41:40Z

Cordiste:

Geeklog plugins are addon components that provide new functionality and leverage the internal services of Geeklog. Many of the available and contributed plugins are listed in this document. Plugins are different then blocks which normally do not use any of the internal Geeklog services (API's).

* See [[Official_Plugins|Official Plugins]]
* See [[UnOfficial_Plugins|Unofficial Plugins]]

There are many services that a plugin can use to provide a tightly coupled application that now performs and looks like it a natural part of the over all Geeklog solution. It's possible to just wrap Geeklog around another application but it may have it's own security and user model for example. It's far better to have a single user database and security model to manage users and access to site features.

Plugins will for example automatically add themselves to your site navigation and provide the ability to restrict and control access to the component for public access and administrative functions.

Geeklog Plugins have access to the following services or API's
* Plugin Editor to install/de-install and enable/disable plugins
* Provide links to the SiteHeader Navigation, User and Admin Menu's
* Add to the site search function
* Extend the site stats reporting
* Leverage the GL Comment Engine
* Automatically update tables upon user add/edit/delete
* Extend the User Account Profile - add new options
* Support moderation to have admin approve content changes
* Provide new RSS Newsfeeds
* Provide a formatted Centerblock
* Integrate into the WhatsNew block

Plugins can be complete applications or provide a new administrative service but they all need to support a minimum set of features to be called a plugin.
* Support the Plugin Editor Install/De-install
* Provide new security rights such as plugin_name.edit and plugin_name.user
* Provide menu integration

Plugins all have a similar installation procedure which requires a few manual steps to copy the plugin related files to the required directories. This part of the plugin installation is often confusing for new users/site admins. This is understandable but once you do one plugin, you will find others much easier to install.

'''''Note:''''' By default the '''staticpages''' plugin is installed as part of the core Geeklog installation. Use this also as an example.

In addition, each plugin may have other steps that need to be performed so read the plugin installation directions carefully.

As an overview to assist you with installing a plugin, I have created an illustrated image that describes the directory structure and locations of the plugin related folders and files. [[Image:PluginInstallOverview.jpg]]

Once the files are copied and in place as required, you will use the Admin Plugin Editor to complete the installation. The plugin editor will automatically list new un-installed plugins if the files have been copied correctly. If not - then review your previous steps.

The plugin editor will call the plugin install or de-install functions - which are part of the new plugin program files. The installation process will
* Create all required new tables
* Add any new default data
* Add the new security rights and update the admin user permissions
* Register the plugin as installed if all these steps are steps are completed without error.

Note: If there are any errors during installation, the plugin will (should) by default remove itself and delete the added tables.

Troubleshooting: Review the Geeklog error.log file for a detailed trace of the installation for any related errors if the install is not successful.

The following illustrated image shows the Plugin Editor with an overview of it's usage.
[[Image:PluginEditor.jpg]]

[[Category:Plugins]]

Geeklog Documentation

2009-05-18T21:34:36Z

Cordiste: /* Geeklog Documentation */

[[Image:Logo.gif]]

== Geeklog Documentation ==

# [[Introduction]]
# [[Installation]]
# [[Administration]]
## ''[[Plugins]]''
## ''[[Themes]]''
# [[Users Documentation|User's Documentation]]
# [[Programmers/Developers Documentation]]

[[Complete Table of Contents]]

Other Themes

2009-05-18T21:20:42Z

Cordiste:

Looking for the Geeklog themes? Here's the place to find them! Welcome to the Geeklog Themes list.

== Geeklog alphabetic Themes list ==

=== colors ===

By [http://geeklog.fr/filemgmt/index.php?id=11 ::Ben]
[[Image:Tn colors.png|200px|thumb|none]]
Last version 1.5.0.4

=== Nouveau ===
By Eric Warren
[[Image:Tn nouveau.png|200px|thumb|none]]
Nouveau is a fixed & fluid width, blue & grey neutral theme

=== Pure ===

By [http://geeklog.fr/filemgmt/index.php?id=18 ::Ben]
[[Image:Tn pure.png|200px|thumb|none]]
Pure is a fluid width theme for Geeklog 1.5.1. Tested it in Firefox 2 and 3, IE 6/7, Opera 9, and Safari beta 3 on Windows. Features: Tableless markup. SEO friendly where content comes first in the code, followed by the left and right blocks. MooTools Javascript Library v1.11 integration, including some javascript widgets. Additional typography elements with quote and code styling, multiple list styling options, and more. Last version 1.5.1.1

----
Feel free to add your theme if you are a designer.

Other Themes

2009-05-18T21:19:13Z

Cordiste: /* Geeklog alphabetic Themes list */

Looking for the Geeklog themes? Here's the place to find them! Welcome to the Geeklog Themes list.

Feel free to add your theme if you are a designer.

== Geeklog alphabetic Themes list ==

=== colors ===

By [http://geeklog.fr/filemgmt/index.php?id=11 ::Ben]
[[Image:Tn colors.png|200px|thumb|none]]
Last version 1.5.0.4

=== Nouveau ===
By Eric Warren
[[Image:Tn nouveau.png|200px|thumb|none]]
Nouveau is a fixed & fluid width, blue & grey neutral theme

=== Pure ===

By [http://geeklog.fr/filemgmt/index.php?id=18 ::Ben]
[[Image:Tn pure.png|200px|thumb|none]]
Pure is a fluid width theme for Geeklog 1.5.1. Tested it in Firefox 2 and 3, IE 6/7, Opera 9, and Safari beta 3 on Windows. Features: Tableless markup. SEO friendly where content comes first in the code, followed by the left and right blocks. MooTools Javascript Library v1.11 integration, including some javascript widgets. Additional typography elements with quote and code styling, multiple list styling options, and more. Last version 1.5.1.1

----

Other Themes

2009-05-18T21:14:14Z

Cordiste: Creation

Looking for the Geeklog themes? Here's the place to find them! Welcome to the Geeklog Themes list.

Feel free to add your theme if you are a designer.

== Geeklog alphabetic Themes list ==

'''Colors''' by [http://geeklog.fr/filemgmt/index.php?id=11 ::Ben]
[[Image:Tn colors.png|200px|thumb|none]]
Last version 1.5.0.4

----

'''Nouveau''' by Eric Warren
[[Image:Tn nouveau.png|200px|thumb|none]]
Nouveau is a fixed & fluid width, blue & grey neutral theme

----

'''Pure''' by [http://geeklog.fr/filemgmt/index.php?id=18 ::Ben]
[[Image:Tn pure.png|200px|thumb|none]]
Pure is a fluid width theme for Geeklog 1.5.1. Tested it in Firefox 2 and 3, IE 6/7, Opera 9, and Safari beta 3 on Windows. Features: Tableless markup. SEO friendly where content comes first in the code, followed by the left and right blocks. MooTools Javascript Library v1.11 integration, including some javascript widgets. Additional typography elements with quote and code styling, multiple list styling options, and more. Last version 1.5.1.1

----

File:Tn colors.png

2009-05-18T21:12:14Z

Cordiste: Colors theme

Colors theme

File:Tn nouveau.png

2009-05-18T20:52:52Z

Cordiste:

File:Tn pure.png

2009-05-18T20:50:08Z

Cordiste: pure theme

pure theme

Themes

2009-05-18T20:26:43Z

Cordiste: Creation of the main theme page

Themes allow you to change the look and feel of your site. The Geeklog designers and developers have done an excellent job of separating the code from the presentation layer, so it is pretty easy to customize your sites look and feel without ever touching the PHP code.

'''Professional theme''' is included in the official release of Geeklog.

[[Image:Professional.png]]

#[[Installing Themes]]
#[[Custom Themes]]
#[[Default Themes]]
#[[Other Themes]]
#[[ThemePort|Porting a Theme]]

File:Professional.png

2009-05-18T20:23:42Z

Cordiste: Professional theme

Professional theme