-
+ ; ?>)
+
+
@@ -70,7 +72,7 @@ if ($userservice->isLoggedOn()) {
) {
echo ' ';
echo !is_array($cDescription) || strlen($cDescription['cdDescription'])==0?T_('Edit the common description of this tag'):'';
- echo '
+
+
+
';
+ echo '  . ')
';
} else if (isset($hash)) {
echo ' (';
echo T_('Edit the common description of this bookmark').')';
@@ -95,7 +97,7 @@ if($userservice->isLoggedOn()) {
if($currenttag!= '') {
echo ' ';
echo strlen($pDescription['tDescription'])==0?T_('Edit your personal description of this tag'):'';
- echo ' ';
+ echo ' ';
}
}
?>
@@ -361,9 +363,15 @@ if ($currenttag!= '') {
}
// Admin specific design
- if ($userservice->isAdmin($row['username']) && $GLOBALS['enableAdminColors']) {
+ if ($userservice->isAdmin($row['username'])
+ && $GLOBALS['enableAdminColors']
+ ) {
$adminBgClass = ' class="adminBackground"';
- $adminStar = ' 
';
+ $adminStar = ' '. T_('Admins, your installation is in "Debug Mode" ($debugMode = true). To go in "Normal Mode" and hide debugging messages, change $debugMode to false into config.php.') ."
\n"; +} +if (isset($error) && $error!='') { + echo ''. $error ."
\n"; +} +if (isset($msg) && $msg!='') { + echo ''. $msg ."
\n"; +} +if (isset($tipMsg) && $tipMsg!='') { + echo ''. $tipMsg ."
\n"; +} +?> diff --git a/data/templates/users.tpl.php b/data/templates/default/users.tpl.php similarity index 100% rename from data/templates/users.tpl.php rename to data/templates/default/users.tpl.php diff --git a/data/templates/top.inc.php b/data/templates/testdummy/top.inc.php similarity index 90% rename from data/templates/top.inc.php rename to data/templates/testdummy/top.inc.php index 738b71e..b85a1ae 100644 --- a/data/templates/top.inc.php +++ b/data/templates/testdummy/top.inc.php @@ -4,8 +4,8 @@>
-.
-
-To provide additional translations:
-- execute of of the scripts in
- with poedit
- (that will update )
-
-
-Links
------
-http://semanticscuttle.wiki.sourceforge.net/
- - further documentation
-
-http://sourceforge.net/forum/forum.php?forum_id=759510
- - support and help questions
-
-https://sourceforge.net/mailarchive/forum.php?forum_name=semanticscuttle-devel
- - development mailing list instructions
-
-http://sourceforge.net/forum/forum.php?forum_id=759511
- - suggestions for SemanticScuttle
-
-http://sourceforge.net/tracker/?group_id=211356&atid=1017430
- - bug reports
-
-https://sourceforge.net/tracker/?group_id=211356&atid=1017433
- - feature requests
-
-https://sourceforge.net/tracker/?group_id=211356&atid=1017432
- - patches
-
-
-Known issues
-------------
-
-Number of bookmarks always 0: "0 bookmark(s)"
- This issue occurs when debug mode is enabled.
- Technically, this is because the database layers DEBUG_EXTRA gets
- enabled through debug mode.
diff --git a/doc/UPGRADE.txt b/doc/UPGRADE.txt
index 53ccbf4..1a0b964 100644
--- a/doc/UPGRADE.txt
+++ b/doc/UPGRADE.txt
@@ -1,266 +1,165 @@
+=================================================
Upgrading SemanticScuttle from a previous version
=================================================
From version 0.97 to 0.98
--------------------------
-Database updates: Apply data/schema/6.sql or do the following:
-
- CREATE TABLE `sc_version` (
- `schema_version` int(11) NOT NULL
- ) DEFAULT CHARSET=utf8;
-
- INSERT INTO `sc_version` (`schema_version`) VALUES ('6');
+=========================
+Database updates
+----------------
+Apply ``data/schema/6.sql``
ALTER TABLE `sc_users` ADD `privateKey` VARCHAR(33) NULL;
CREATE UNIQUE INDEX `privateKey` ON `sc_users` (`privateKey`);
From version 0.96 to 0.97
--------------------------
+=========================
No database changes necessary.
From version 0.95 to 0.96
--------------------------
-Update your database:
-- ALTER TABLE `sc_bookmarks` ADD `bShort` VARCHAR(16) NULL DEFAULT NULL;
+=========================
+Database updates
+----------------
+Apply ``data/schema/5.sql``
-API:
-The method signatures of addBookmark() and updateBookmark()
-changed due to the addition of the $short parameter.
+API
+---
+The method signatures of ``addBookmark()`` and ``updateBookmark()``
+changed due to the addition of the ``$short`` parameter.
We got complaints about the changed file structure, and people told
-us that they just cannot set the document root to www/, because they
-are not admins on their http server. This is a valid point, and
-with 0.96.0 you can easily change it. See INSTALL.txt for more information
-about moving www/.
+us that they just cannot set the document root to ``www/``, because they
+are not admins on their HTTP server. This is a valid point, and
+with 0.96.0 you can easily change it. See `INSTALL.txt`_ for more information
+about moving ``www/``.
+
+.. _INSTALL.txt: INSTALL.html
From version 0.94 to 0.95
---------------------------
+=========================
The file structure completely changed in 0.95.0 compared
to previous versions. We recommend that you start with a
-fresh installation, just copying over your config.php file.
-Set your web server document root directory to www/.
+fresh installation, just copying over your ``config.php`` file.
+Set your web server document root directory to ``www/``.
Yes, we kind of lost the ability to run SemanticScuttle
in a subdirectory of a hostname. This functionality will
be back in one of the next releases, but for now, you have
to live with it.
-Update your database:
-- ALTER TABLE `sc_bookmarks` ADD `bVoting` INT NOT NULL;
-- ALTER TABLE `sc_bookmarks` ADD `bVotes` INT NOT NULL;
-- Add the new votes database table. See data/tables.sql.
+Update your database
+--------------------
+Apply ``data/schema/4.sql``.
Currently, only MySQL can be used as database backend.
All other DBMS (database management systems) have not been
tested except for PostgreSQL, and SemanticScuttle fails there.
-The de_AT translation has been re-added. This is because
-de_AT provides a rather ugly "official German" style,
-while the normal de_DE is friendlier. Choose what you like.
+Translation
+-----------
+The ``de_AT`` translation has been re-added. This is because
+``de_AT`` provides a rather ugly "official German" style,
+while the normal ``de_DE`` is friendlier. Choose what you like.
From version 0.93 to 0.94
--------------------------
+=========================
- Nothing changed except for the default configuration file.
It is recommended to start with a fresh config file,
but not neccesary. Old config files still work.
-- If you used translation de_AT, please switch to de_DE.
- de_AT was moved to de_DE and de_AT has been removed.
+- If you used translation ``de_AT``, please switch to ``de_DE``.
+ ``de_AT`` was moved to ``de_DE`` and ``de_AT`` has been removed.
From version 0.92 to 0.93
--------------------------
+=========================
- Backup your database
- Make a copy from your SemanticScuttle Web directory
-- Upgrade your database by following instructions ONE after ONE (order is important) :
-#NOTHING TO CHANGE IN DB
-- Upgrade your current configuration file (config.inc.php) with respect to config.inc.php.example
-$footerMessage = ''; #HTML message appearing at the bottom of the page (just above SemanticScuttle credits)
-$sidebarTopMessage = ''; #HTML message appearing at the top of the sidebar
-$sidebarBottomMessage = ''; #HTML message appearing at the bottom of the sidebar
-$adminsCanModifyBookmarksFromOtherUsers = true; # 'true' if admin users can edit or delete bookmarks belonging to other users. Else 'false'.
-$adminsAreAdvisedTagsFromOtherAdmins = false; # 'true' if tags from other admins are proposed to each admin (in add/edit a bookmark page). Else 'false'.
-$defaultPerPageForAdmins = 20; # default number of bookmarks per page for admins (-1 means no limit)
+- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example`` ::
+
+ $footerMessage = ''; #HTML message appearing at the bottom of the page (just above SemanticScuttle credits)
+ $sidebarTopMessage = ''; #HTML message appearing at the top of the sidebar
+ $sidebarBottomMessage = ''; #HTML message appearing at the bottom of the sidebar
+ $adminsCanModifyBookmarksFromOtherUsers = true; # 'true' if admin users can edit or delete bookmarks belonging to other users. Else 'false'.
+ $adminsAreAdvisedTagsFromOtherAdmins = false; # 'true' if tags from other admins are proposed to each admin (in add/edit a bookmark page). Else 'false'.
+ $defaultPerPageForAdmins = 20; # default number of bookmarks per page for admins (-1 means no limit)
From version 0.91 to 0.92
--------------------------
+=========================
Message: this version modifies the database to UTF-8 charset. The idea is to convert the content (through BLOB type) and then to change the tables' charsets.
- Backup your database
- Make a copy from your SemanticScuttle Web directory
-- Upgrade your database by following instructions ONE after ONE (order is important) :
+- Upgrade your database by applying ``data/schema/3.sql``
+- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example``
-/* modify and add fields */
-ALTER TABLE `sc_bookmarks` MODIFY `bAddress` varchar(1500) NOT NULL;
-ALTER TABLE `sc_bookmarks` MODIFY `bDescription` TEXT default NULL;
-ALTER TABLE `sc_bookmarks` ADD `bPrivateNote` TEXT NULL AFTER `bDescription` ;
-ALTER TABLE `sc_tags` MODIFY `tDescription` TEXT default NULL;
-ALTER TABLE `sc_commondescription` MODIFY `cdDescription` TEXT default NULL;
+ - Add variable ::
-/* convert to UTF-8 if your table is ISO-something (through BLOB: tips provided by MYSQL documentation)*/
-/* first need to remove index keys because of BLOB constraints*/
-ALTER TABLE `sc_tags` DROP INDEX `sc_tags_tag_uId`;
-ALTER TABLE `sc_bookmarks2tags` DROP INDEX `sc_bookmarks2tags_tag_bId`;
-ALTER TABLE `sc_bookmarks2tags` DROP INDEX `sc_bookmarks2tags_bId`;
-ALTER TABLE `sc_tags2tags` DROP INDEX `sc_tags2tags_tag1_tag2_uId`;
-ALTER TABLE `sc_commondescription` DROP INDEX `sc_commondescription_tag_datetime`;
-ALTER TABLE `sc_tagscache` DROP INDEX `sc_tagscache_tag1_tag2_type_uId`;
-ALTER TABLE `sc_tagsstats` DROP INDEX `sc_tagsstats_tag1_type_uId`;
+ $descriptionAnchors = array("author", "isbn", "address"=>"[address][street][/street][city][/city][/address]"); #add a possible anchor (structured content) for bookmarks' description field
-/* secondly convert through BLOB type */
-ALTER TABLE `sc_bookmarks` CHANGE `bTitle` `bTitle` BLOB;
-ALTER TABLE `sc_bookmarks` CHANGE `bTitle` `bTitle` varchar(255) CHARACTER SET utf8;
-ALTER TABLE `sc_bookmarks` CHANGE `bAddress` `bAddress` BLOB;
-ALTER TABLE `sc_bookmarks` CHANGE `bAddress` `bAddress` varchar(1500) CHARACTER SET utf8;
-ALTER TABLE `sc_bookmarks` CHANGE `bDescription` `bDescription` BLOB;
-ALTER TABLE `sc_bookmarks` CHANGE `bDescription` `bDescription` text CHARACTER SET utf8;
-ALTER TABLE `sc_bookmarks` CHANGE `bPrivateNote` `bPrivateNote` BLOB;
-ALTER TABLE `sc_bookmarks` CHANGE `bPrivateNote` `bPrivateNote` text CHARACTER SET utf8;
+ - Add variable ::
-ALTER TABLE `sc_tags` CHANGE `tag` `tag` BLOB;
-ALTER TABLE `sc_tags` CHANGE `tag` `tag` varchar(100) CHARACTER SET utf8;
-ALTER TABLE `sc_tags` CHANGE `tDescription` `tDescription` BLOB;
-ALTER TABLE `sc_tags` CHANGE `tDescription` `tDescription` text CHARACTER SET utf8;
+ $enableCommonTagDescriptionEditedByAll = true; #true mean everybody can edit common description. Else just the admins can do it.
+ - Add variable ::
-ALTER TABLE `sc_bookmarks2tags` CHANGE `tag` `tag` BLOB;
-ALTER TABLE `sc_bookmarks2tags` CHANGE `tag` `tag` varchar(100) CHARACTER SET utf8;
-
-ALTER TABLE `sc_users` CHANGE `name` `name` BLOB;
-ALTER TABLE `sc_users` CHANGE `name` `name` varchar(50) CHARACTER SET utf8;
-ALTER TABLE `sc_users` CHANGE `uContent` `uContent` BLOB;
-ALTER TABLE `sc_users` CHANGE `uContent` `uContent` text CHARACTER SET utf8;
-
-ALTER TABLE `sc_tags2tags` CHANGE `tag1` `tag1` BLOB;
-ALTER TABLE `sc_tags2tags` CHANGE `tag1` `tag1` varchar(100) CHARACTER SET utf8;
-ALTER TABLE `sc_tags2tags` CHANGE `tag2` `tag2` BLOB;
-ALTER TABLE `sc_tags2tags` CHANGE `tag2` `tag2` varchar(100) CHARACTER SET utf8;
-
-ALTER TABLE `sc_tagsstats` CHANGE `tag1` `tag1` BLOB;
-ALTER TABLE `sc_tagsstats` CHANGE `tag1` `tag1` varchar(100) CHARACTER SET utf8;
-
-ALTER TABLE `sc_tagscache` CHANGE `tag1` `tag1` BLOB;
-ALTER TABLE `sc_tagscache` CHANGE `tag1` `tag1` varchar(100) CHARACTER SET utf8;
-ALTER TABLE `sc_tagscache` CHANGE `tag2` `tag2` BLOB;
-ALTER TABLE `sc_tagscache` CHANGE `tag2` `tag2` varchar(100) CHARACTER SET utf8;
-
-ALTER TABLE `sc_commondescription` CHANGE `tag` `tag` BLOB;
-ALTER TABLE `sc_commondescription` CHANGE `tag` `tag` varchar(100) CHARACTER SET utf8;
-ALTER TABLE `sc_commondescription` CHANGE `cdTitle` `cdTitle` BLOB;
-ALTER TABLE `sc_commondescription` CHANGE `cdTitle` `cdTitle` varchar(255) CHARACTER SET utf8;
-ALTER TABLE `sc_commondescription` CHANGE `cdDescription` `cdDescription` BLOB;
-ALTER TABLE `sc_commondescription` CHANGE `cdDescription` `cdDescription` text CHARACTER SET utf8;
-
-ALTER TABLE `sc_searchhistory` CHANGE `shTerms` `shTerms` BLOB;
-ALTER TABLE `sc_searchhistory` CHANGE `shTerms` `shTerms` varchar(255) CHARACTER SET utf8;
-ALTER TABLE `sc_searchhistory` CHANGE `shRange` `shRange` BLOB;
-ALTER TABLE `sc_searchhistory` CHANGE `shRange` `shRange` varchar(32) CHARACTER SET utf8;
-
-/* Thirdly re-add index keys */
-ALTER TABLE `sc_tags` ADD UNIQUE KEY `sc_tags_tag_uId` (`tag`, `uId`);
-ALTER TABLE `sc_bookmarks2tags` ADD UNIQUE KEY `sc_bookmarks2tags_tag_bId` (`tag`,`bId`);
-ALTER TABLE `sc_bookmarks2tags` ADD KEY `sc_bookmarks2tags_bId` (`bId`);
-ALTER TABLE `sc_tags2tags` ADD UNIQUE KEY `sc_tags2tags_tag1_tag2_uId` (`tag1`,`tag2`,`relationType`,`uId`);
-ALTER TABLE `sc_commondescription` ADD UNIQUE KEY `sc_commondescription_tag_datetime` (`tag`,`cdDatetime`);
-ALTER TABLE `sc_tagscache` ADD UNIQUE KEY `sc_tagscache_tag1_tag2_type_uId` (`tag1`,`tag2`,`relationType`,`uId`);
-ALTER TABLE `sc_tagsstats` ADD UNIQUE KEY `sc_tagsstats_tag1_type_uId` (`tag1`,`relationType`,`uId`);
-
-/* Change tables to utf-8 charset */
-ALTER TABLE `sc_bookmarks` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_tags` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_bookmarks2tags` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_users` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_watched` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_tags2tags` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_tagsstats` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_tagscache` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_commondescription` CHARACTER SET utf8 COLLATE utf8_general_ci;
-ALTER TABLE `sc_searchhistory` CHARACTER SET utf8 COLLATE utf8_general_ci;
-
-- Upgrade your current configuration file (config.inc.php) with respect to config.inc.php.example
-* Add variable : $descriptionAnchors = array("author", "isbn", "address"=>"[address][street][/street][city][/city][/address]"); #add a possible anchor (structured content) for bookmarks' description field
-* Add variable : $enableCommonTagDescriptionEditedByAll = true; #true mean everybody can edit common description. Else just the admins can do it.
-* Add variable : $googleAnalyticsCode = ''; #Allow GoogleAnalytics tracker https://www.google.com/analytics/
+ $googleAnalyticsCode = ''; #Allow GoogleAnalytics tracker https://www.google.com/analytics/
From version 0.90 to 0.91
--------------------------
+=========================
- Backup you database
- Make a copy from your SemanticScuttle Web directory
-- Upgrade your database by following instructions ONE after ONE (order is important) :
- * ALTER TABLE `sc_bookmarks` CHANGE `bDescription` `bDescription` VARCHAR( 1500 )
- * CREATE TABLE `sc_tagscache` (
- `tcId` int(11) NOT NULL auto_increment,
- `tag1` varchar(100) NOT NULL default '',
- `tag2` varchar(100) NOT NULL default '',
- `relationType` varchar(32) NOT NULL default '',
- `uId` int(11) NOT NULL default '0',
- PRIMARY KEY (`tcId`),
- UNIQUE KEY `sc_tagscache_tag1_tag2_type_uId` (`tag1`,`tag2`,`relationType`,`uId`)
-);
-- Upgrade your current configuration file (config.inc.php) with respect to config.inc.php.example
- * Delete last line : include_once('debug.inc.php');
- * Add variable: $menu2Tags = array('example', 'of', 'menu', 'tags');
- * Add variable: $debugMode = true; # if true, show debug messages
+- Upgrade your database by applying ``data/schema/2.sql``
+- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example``
+
+ - Delete last line ::
+
+ include_once('debug.inc.php');
+
+ - Add variable::
+
+ $menu2Tags = array('example', 'of', 'menu', 'tags');
+
+ - Add variable::
+
+ $debugMode = true; # if true, show debug messages
From version 0.89 to 0.90
--------------------------
+=========================
- Backup you database
- Make a copy from your SemanticScuttle Web directory
- Upgrade your current configuration file (config.inc.php) with respect to config.inc.php.example
-# add these lines under $enableWebsiteThumbnails = false; # enableWebsiteThumbnails {true|false}:
-$thumbnailsUserId = '';
-$thumbnailsKey = '';
+ add these lines under ``$enableWebsiteThumbnails = false; # enableWebsiteThumbnails {true|false}``::
+
+ $thumbnailsUserId = '';
+ $thumbnailsKey = '';
From version 0.88 to 0.89
--------------------------
+=========================
- Backup you database
- Make a copy from your SemanticScuttle Web directory
-- Upgrade your database by following instructions ONE after ONE (order is important) :
+- Upgrade your database by applying ``data/schema/1.sql``
+- Upgrade your current configuration file (``config.inc.php``) with respect to ``config.inc.php.example``
+ - add line::
-* change the table called 'sc_tags' into 'sc_bookmarks2tags' by executing the following SQL commands (after changing 'yourdatabasename' and adapting its name prefix 'sc_' to your convenience):
-
- RENAME TABLE `yourdatabasename`.`sc_tags` TO `yourdatabasename`.`sc_bookmarks2tags` ;
-
-
-* add the following table (adapt its name prefix to your convenience) executing the following SQL commands:
-
- CREATE TABLE `sc_searchhistory` (
- `shId` int(11) NOT NULL auto_increment,
- `shTerms` varchar(255) NOT NULL default '',
- `shRange` varchar(32) NOT NULL default '',
- `shDatetime` datetime NOT NULL default '0000-00-00 00:00:00',
- `shNbResults` int(6) NOT NULL default '0',
- `uId` int(11) NOT NULL default '0',
- PRIMARY KEY (`shId`)
- );
-
- CREATE TABLE `sc_tags` (
- `tId` int(11) NOT NULL auto_increment,
- `tag` varchar(32) NOT NULL default '',
- `uId` int(11) NOT NULL default '0',
- `tDescription` varchar(255) default NULL,
- PRIMARY KEY (`tId`),
- UNIQUE KEY `sc_tags_tag_uId` (`tag`, `uId`)
- );
-
-- Upgrade your current configuration file (config.inc.php) with respect to config.inc.php.example
- # add line:
$sizeSearchHistory = 10;
- # add sidebar block index line:
+
+ - add sidebar block index line::
+
$index_sidebar_blocks = array('search','menu','users','popular');
- # add line:
+
+ - add line::
$enableGoogleCustomSearch = true;
diff --git a/doc/authentication.rst b/doc/authentication.rst
new file mode 100644
index 0000000..c3ccb47
--- /dev/null
+++ b/doc/authentication.rst
@@ -0,0 +1,213 @@
+============================================
+External authentication with SemanticScuttle
+============================================
+
+Most times, one piece of software is only a part in the big puzzle
+that makes the software landscape of a company or organization.
+SemanticScuttle is not different and should integrate as nicely as
+possible with all other systems.
+
+One of the basic tasks of integration is user authentication against
+a central database - be it a central user database, an LDAP or a
+active directory server.
+
+Since version 0.96, SemanticScuttle supports user authentication against
+external systems. To provide a wide range of supported systems, we chose
+to utilize PEAR's `Authentication package`__.
+It does this by providing different "`authentication containers`__",
+for example Database, IMAP, LDAP, POP3, RADIUS, SAP and SOAP.
+
+Please be aware of the fact that, after successful authentication, the user
+and his scrambled password are stored in the SemanticScuttle database.
+This is required for proper functioning of the software. It does not mean
+that you will be able to login if your external authentication provider
+is offline - you won't, execpt you switch it off in the SemanticScuttle
+configuration.
+
+
+__ http://pear.php.net/package/Auth
+__ http://pear.php.net/manual/en/package.authentication.auth.intro-storage.php
+
+
+Basic configuration
+===================
+The default configuration file ``data/config.default.php`` has an own section
+on auth options and an explanation of the single entries.
+
+To utilize the external authentication, you need to install the
+PEAR Auth package: ::
+
+ $ pear install auth
+
+If you do not have a PEAR installation available, you can try to manually
+install the files in the src/ directory. If you choose to do that, the
+src/ directory should look similar to that: ::
+
+ src/
+ Auth.php
+ Auth/
+ Anonymous.php
+ Container.php
+ Container/
+ ..
+ SemanticScuttle/
+ header.php
+ ..
+
+After that, modify your ``data/config.php`` file. The most important change
+is to use ::
+
+ $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
+
+which tells SemanticScuttle to switch to the special authentication service.
+
+Now that's done, you can configure the single auth options:
+
+``$authType = 'MDB2';``
+ selects the authentication container.
+
+``$authOptions``
+ is an array of options specific to the authentication container. Please
+ consult the PEAR Auth documentation for more information.
+
+``$authDebug = true;``
+ should be used when setup fails, since it may give important hints
+ where it fails.
+
+ Please note that login will seem to fail with
+ debugging activated. Going back to the main page after that will
+ show that you are logged in.
+
+
+
+Authentication examples
+=======================
+
+General database authentification
+---------------------------------
+Here you also need the PEAR `MDB2 package`_.
+The "``new_link``" option is important!
+
+``config.php`` settings: ::
+
+ $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
+ $authType = 'MDB2';
+ $authOptions = array(
+ 'dsn' => array(
+ 'phptype' => 'mysql',
+ 'hostspec' => 'FIXME',
+ 'username' => 'FIXME',
+ 'password' => 'FIXME',
+ 'database' => 'FIXME',
+ 'new_link' => true,
+ ),
+ 'table' => 'usersFIXME',
+ 'usernamecol' => 'usernameFIXME',
+ 'passwordcol' => 'passwordFIXME',
+ 'cryptType' => 'md5',
+ );
+
+
+Mantis Bugtracker
+-----------------
+Here you also need the PEAR `MDB2 package`_.
+
+``config.php`` settings: ::
+
+ $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
+ $authType = 'MDB2';
+ $authOptions = array(
+ 'dsn' => array(
+ 'phptype' => 'mysql',
+ 'hostspec' => 'FIXME',
+ 'username' => 'FIXME',
+ 'password' => 'FIXME',
+ 'database' => 'FIXME',
+ 'new_link' => true,
+ ),
+ 'table' => 'mantis_user_table',
+ 'usernamecol' => 'username',
+ 'passwordcol' => 'password',
+ 'cryptType' => 'md5',
+ );
+
+.. _MDB2 package: http://pear.php.net/package/MDB2
+
+
+MediaWiki
+---------
+Unfortunately, the password column does not contain a simple hashed
+password - for good reasons as described on
+http://www.mediawiki.org/wiki/Manual_talk:User_table#user_password_column
+
+If you configure your MediaWiki_ to use passwords without salt, you
+can make it work nevertheless:
+
+MediaWiki ``LocalSettings.php``: ::
+
+ $wgPasswordSalt = false;
+
+\- after that, users need to change/update their passwords to get them
+unsalted in the database. You can verify if the passwords are unhashed
+if you do ::
+
+ SELECT CAST( user_password AS CHAR ) FROM user
+
+on your MediaWiki database. Passwords prefixed with "``:A:``" can be used.
+
+Another problem is that mediawiki user names begin with an uppercase letter.
+You need to modify ``www/login.php`` and remove the "``utf8_strtolower``" function
+call: ::
+
+ $posteduser = trim(utf8_strtolower(POST_USERNAME));
+
+becomes ::
+
+ $posteduser = trim(POST_USERNAME);
+
+
+``config.php`` settings: ::
+
+ $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
+ $authType = 'MDB2';
+ $authOptions = array(
+ 'dsn' => array(
+ 'phptype' => 'mysql',
+ 'hostspec' => 'FIXME',
+ 'username' => 'FIXME',
+ 'password' => 'FIXME',
+ 'database' => 'FIXME',
+ 'new_link' => true,
+ ),
+ 'table' => 'user',
+ 'usernamecol' => 'user_name',
+ 'passwordcol' => 'user_password',
+ 'cryptType' => 'md5_mediawiki',
+ );
+ function md5_mediawiki($password) {
+ return ':A:' . md5($password);
+ }
+
+
+.. _MediaWiki: http://www.mediawiki.org/wiki/MediaWiki
+
+Active Directory / LDAP
+-----------------------
+Here we authenticate against an active directory server.
+
+``config.php`` settings: ::
+
+ $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
+ $authType = 'LDAP';
+ $authOptions = array(
+ 'host' => '192.168.1.4',
+ 'version' => 3,
+ 'basedn' => 'DC=EXAMPLE,DC=ORG',
+ 'binddn' => 'readuser',
+ 'bindpw' => 'readuser',
+ 'userattr' => 'sAMAccountName',
+ 'userfilter' => '(objectClass=user)',
+ 'attributes' => array(''),
+ );
+ $authEmailSuffix = '@example.org';
+
diff --git a/doc/authentication.txt b/doc/authentication.txt
deleted file mode 100644
index da49e5a..0000000
--- a/doc/authentication.txt
+++ /dev/null
@@ -1,197 +0,0 @@
-External authentication with SemanticScuttle
-============================================
-
-Most times, one piece of software is only a part in the big puzzle
-that makes the software landscape of a company or organization.
-SemanticScuttle is not different and should integrate as nicely as
-possible with all other systems.
-
-One of the basic tasks of integration is user authentication against
-a central database - be it a central user database, an LDAP or a
-active directory server.
-
-Since version 0.96, SemanticScuttle supports user authentication against
-external systems. To provide a wide range of supported systems, we chose
-to utilize PEAR's Authentication package [1].
-It does this by providing different "authentication containers" [2],
-for example Database, IMAP, LDAP, POP3, RADIUS, SAP and SOAP.
-
-Please be aware of the fact that, after successful authentication, the user
-and his scrambled password are stored in the SemanticScuttle database.
-This is required for proper functioning of the software. It does not mean
-that you will be able to login if your external authentication provider
-is offline - you won't, execpt you switch it off in the SemanticScuttle
-configuration.
-
-
-[1] http://pear.php.net/package/Auth
-[2] http://pear.php.net/manual/en/package.authentication.auth.intro-storage.php
-
-
-Basic configuration
-===================
-The default configuration file data/config.default.php has an own section
-on auth options and an explanation of the single entries.
-
-To utilize the external authentication, you need to install the
-PEAR Auth package:
- $ pear install auth
-If you do not have a PEAR installation available, you can try to manually
-install the files in the src/ directory. If you choose to do that, the
-src/ directory should look similar to that:
-
- src/
- Auth.php
- Auth/
- Anonymous.php
- Container.php
- Container/
- ..
- SemanticScuttle/
- header.php
- ..
-
-After that, modify your data/config.php file. The most important change
-is to use
- $serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
-which tells SemanticScuttle to switch to the special authentication service.
-
-Now that's done, you can configure the single auth options:
- $authType = 'MDB2';
-selects the authentication container.
-
- $authOptions
-is an array of options specific to the authentication container. Please
-consult the PEAR Auth documentation for more information.
-
- $authDebug = true;
-should be used when setup fails, since it may give important hints
-where it fails. Please note that login will seem to fail with
-debugging activated. Going back to the main page after that will
-show that you are logged in.
-
-
-
-Authentication examples
-=======================
-
-General database authentification
----------------------------------
-Here you also need the PEAR MDB2 package.
-The "new_link" option is important!
-
-config.php settings:
--8<------------------
-$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
-$authType = 'MDB2';
-$authOptions = array(
- 'dsn' => array(
- 'phptype' => 'mysql',
- 'hostspec' => 'FIXME',
- 'username' => 'FIXME',
- 'password' => 'FIXME',
- 'database' => 'FIXME',
- 'new_link' => true,
- ),
- 'table' => 'usersFIXME',
- 'usernamecol' => 'usernameFIXME',
- 'passwordcol' => 'passwordFIXME',
- 'cryptType' => 'md5',
-);
--8<------------------
-
-
-Mantis Bugtracker
------------------
-Here you also need the PEAR MDB2 package.
-
-config.php settings:
--8<------------------
-$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
-$authType = 'MDB2';
-$authOptions = array(
- 'dsn' => array(
- 'phptype' => 'mysql',
- 'hostspec' => 'FIXME',
- 'username' => 'FIXME',
- 'password' => 'FIXME',
- 'database' => 'FIXME',
- 'new_link' => true,
- ),
- 'table' => 'mantis_user_table',
- 'usernamecol' => 'username',
- 'passwordcol' => 'password',
- 'cryptType' => 'md5',
-);
--8<------------------
-
-
-MediaWiki
----------
-Unfortunately, the password column does not contain a simple hashed
-password - for good reasons as described on
-http://www.mediawiki.org/wiki/Manual_talk:User_table#user_password_column
-
-If you configure your mediawiki to use passwords without salt, you
-can make it work nevertheless:
-
-MediaWiki LocalSettings.php:
- $wgPasswordSalt = false;
-- after that, users need to change/update their passwords to get them
-unsalted in the database. You can verify if the passwords are unhashed
-if you do
- SELECT CAST( user_password AS CHAR ) FROM user
-on your MediaWiki database. Passwords prefixed with ":A:" can be used.
-
-Another problem is that mediawiki user names begin with an uppercase letter.
-You need to modify www/login.php and remove the "utf8_strtolower" function
-call:
- $posteduser = trim(utf8_strtolower(POST_USERNAME));
-becomes
- $posteduser = trim(POST_USERNAME);
-
-
-config.php settings:
--8<------------------
-$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
-$authType = 'MDB2';
-$authOptions = array(
- 'dsn' => array(
- 'phptype' => 'mysql',
- 'hostspec' => 'FIXME',
- 'username' => 'FIXME',
- 'password' => 'FIXME',
- 'database' => 'FIXME',
- 'new_link' => true,
- ),
- 'table' => 'user',
- 'usernamecol' => 'user_name',
- 'passwordcol' => 'user_password',
- 'cryptType' => 'md5_mediawiki',
-);
-function md5_mediawiki($password) {
- return ':A:' . md5($password);
-}
--8<------------------
-
-
-Active Directory / LDAP
------------------------
-Here we authenticate against an active directory server.
-
-config.php settings:
--8<------------------
-$serviceoverrides['User'] = 'SemanticScuttle_Service_AuthUser';
-$authType = 'LDAP';
-$authOptions = array(
- 'host' => '192.168.1.4',
- 'version' => 3,
- 'basedn' => 'DC=EXAMPLE,DC=ORG',
- 'binddn' => 'readuser',
- 'bindpw' => 'readuser',
- 'userattr' => 'sAMAccountName',
- 'userfilter' => '(objectClass=user)',
- 'attributes' => array(''),
-);
-$authEmailSuffix = '@example.org';
--8<------------------
diff --git a/doc/developers/TODO b/doc/developers/TODO.rst
similarity index 100%
rename from doc/developers/TODO
rename to doc/developers/TODO.rst
diff --git a/doc/developers/api b/doc/developers/api.rst
similarity index 100%
rename from doc/developers/api
rename to doc/developers/api.rst
diff --git a/doc/developers/debugging b/doc/developers/debugging
deleted file mode 100644
index 7f84da6..0000000
--- a/doc/developers/debugging
+++ /dev/null
@@ -1,20 +0,0 @@
-How to debug SemanticScuttle
-============================
-
-
-Database queries
-----------------
-In config.php, enable debugMode.
-Further, add the following there:
--------
-register_shutdown_function(
- create_function('', <<sql_report('display');
-FNC
- )
-);
-------
-To see database queries in SemanticScuttle, add
-> ?explain=1
-to your URL.
diff --git a/doc/developers/debugging.rst b/doc/developers/debugging.rst
new file mode 100644
index 0000000..6bee309
--- /dev/null
+++ b/doc/developers/debugging.rst
@@ -0,0 +1,24 @@
+How to debug SemanticScuttle
+============================
+
+
+Database queries
+----------------
+
+In ``data/config.php``, enable ``debugMode``.
+Further, add the following afterwards: ::
+
+ register_shutdown_function(
+ create_function('', <<sql_report('display');
+ FNC
+ )
+ );
+
+
+To see database queries in SemanticScuttle, add ::
+
+ ?explain=1
+
+to your URL.
diff --git a/doc/developers/doc-TODO b/doc/developers/doc-TODO.rst
similarity index 100%
rename from doc/developers/doc-TODO
rename to doc/developers/doc-TODO.rst
diff --git a/doc/developers/release-new-version b/doc/developers/release-new-version.rst
similarity index 100%
rename from doc/developers/release-new-version
rename to doc/developers/release-new-version.rst
diff --git a/doc/developers/rules b/doc/developers/rules.rst
similarity index 100%
rename from doc/developers/rules
rename to doc/developers/rules.rst
diff --git a/doc/developers/running-unit-tests b/doc/developers/running-unit-tests
deleted file mode 100644
index 556055f..0000000
--- a/doc/developers/running-unit-tests
+++ /dev/null
@@ -1,21 +0,0 @@
-Running unit tests
-==================
-
-Go to the SemanticScuttle main directory and run
- $ php tests/AllTests.php
-or
- $ phpunit tests/AllTests.php
-also remember the --verbose parameter to PHPUnit.
-
-If you want to run a specific test class only:
- $ phpunit tests/BookmarksTest.php
-
-If you need to test one method only:
- $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php
-
-
-Caveats
--------
-Having debugging enabled and database driver "mysql4" activated
-will lead to failing tests because of FOUND_ROWS() usage, which
-does not work nicely with database debugging.
diff --git a/doc/developers/running-unit-tests.rst b/doc/developers/running-unit-tests.rst
new file mode 100644
index 0000000..8b0fa0d
--- /dev/null
+++ b/doc/developers/running-unit-tests.rst
@@ -0,0 +1,26 @@
+Running unit tests
+==================
+
+Go to the SemanticScuttle ``tests`` directory and run ``phpunit``::
+
+ $ cd tests
+ $ phpunit .
+
+also remember the ``--verbose`` parameter to PHPUnit.
+
+If you want to run a specific test class only: ::
+
+ $ cd tests
+ $ phpunit BookmarksTest.php
+
+If you need to test one method only: ::
+
+ $ cd tests
+ $ phpunit --filter BookmarkTest::testUnificationOfBookmarks tests/BookmarkTest.php
+
+
+Caveats
+-------
+Having debugging enabled and database driver "``mysql4``" activated
+will lead to failing tests because of ``FOUND_ROWS()`` usage, which
+does not work nicely with database debugging.
diff --git a/doc/developers/translation b/doc/developers/translation
deleted file mode 100644
index 776b5d7..0000000
--- a/doc/developers/translation
+++ /dev/null
@@ -1,40 +0,0 @@
-Translating SemanticScuttle
-===========================
-
-SemanticScuttle uses gnu gettext for translation. It does not
-rely on the php extension but ships with a pure php implementation,
-php-gettext[1].
-
-Using gettext from within the code is really easy:
-Enclose the string you want to translate in a "T_" function call.
-
-For example, to translate
-> echo "Vote for";
-just write
-> echo T_("Vote for");
-
-
-Translation basics
-------------------
-
-We keep one base translation file, data/locales/messages.po.
-This file is auto-generated via xgettext from all our php source files.
-In case you added a new string to the code that needs translation,
-update the base translation file by running
-> php scripts/update-translation-base.php
-
-After that has been done, the changes to the base messages.po file
-need to be merged into the single language translation files,
-for example data/locales/de_DE/LC_MESSAGES/messages.po.
-
-Updating them from the master file is as easy as running
-> php scripts/update-translation.php de_DE
-
-When the translation is ready, the .po file needs to be compiled
-in a machine-readable .mo file. Use
-> php scripts/compile-translation.php de_DE
-to achieve that.
-
-
-
-[1] https://launchpad.net/php-gettext/
\ No newline at end of file
diff --git a/doc/developers/translation.rst b/doc/developers/translation.rst
new file mode 100644
index 0000000..008f66e
--- /dev/null
+++ b/doc/developers/translation.rst
@@ -0,0 +1,47 @@
+===========================
+Translating SemanticScuttle
+===========================
+
+SemanticScuttle uses gnu gettext for translation. It does not
+rely on the php extension but ships with a pure php implementation,
+php-gettext_.
+
+Using gettext from within the code is really easy:
+Enclose the string you want to translate in a "``T_``" function call.
+
+For example, to translate::
+
+ echo "Vote for";
+
+just write ::
+
+ echo T_("Vote for");
+
+.. _php-gettext: https://launchpad.net/php-gettext/
+
+Translation basics
+==================
+
+We keep one base translation file, ``data/locales/messages.po``.
+This file is auto-generated via ``xgettext`` from all our php source files.
+In case you added a new string to the code that needs translation,
+update the base translation file by running ::
+
+ $ php scripts/update-translation-base.php
+
+After that has been done, the changes to the base ``messages.po`` file
+need to be merged into the single language translation files,
+for example ``data/locales/de_DE/LC_MESSAGES/messages.po``.
+
+Updating them from the master file is as easy as running::
+
+ $ php scripts/update-translation.php de_DE
+
+When the translation is ready, the ``.po`` file needs to be compiled
+in a machine-readable ``.mo`` file. Use ::
+
+ $ php scripts/compile-translation.php de_DE
+
+to achieve that.
+
+
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..1b8feea
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,45 @@
+=============================
+SemanticScuttle documentation
+=============================
+
+
+First reads
+===========
+- README_
+- `installation guide`_
+- `upgrade instructions`_
+
+.. _README: README.html
+.. _installation guide: INSTALL.html
+.. _upgrade instructions: UPGRADE.html
+
+
+
+Features
+========
+- `Custom user authentication`__
+- `SSL Client certificates`__
+- Themes__
+
+__ authentication.html
+__ ssl-client-certificates.html
+__ themes.html
+
+
+
+Developer documentation
+=======================
+- `General development rules`__
+- `Delicious API`__
+- `Debugging HowTo`__
+- `How to release a new version`__
+- `Running unit testes`__
+- `How to translate SemanticScuttle`__
+
+__ developers/rules.html
+__ developers/api.html
+__ developers/debugging.html
+__ developers/release-new-version.html
+__ developers/running-unit-tests.html
+__ developers/translation.html
+
diff --git a/doc/themes.rst b/doc/themes.rst
new file mode 100644
index 0000000..6f34a36
--- /dev/null
+++ b/doc/themes.rst
@@ -0,0 +1,48 @@
+======================
+SemanticScuttle Themes
+======================
+SemanticScuttle may be changed visually by supplying custom "themes" (skins)
+that modify the visual appearance.
+
+
+Changing the current theme
+==========================
+In ``data/config.php``, set your theme like this: ::
+
+ $theme = 'darkmood';
+
+The available themes are the folders in ``www/themes/``.
+By default, SemanticScuttle ships only one usable theme ("default") and one
+to demonstrate how to create your own theme ("testdummy").
+
+
+Creating your own theme
+=======================
+Have a look at the "testdummy" theme in ``www/themes/testdummy/``.
+
+CSS and image files
+-------------------
+Since both file types need to be accessible via the web server directly,
+they are located in the ``www/`` folder: ::
+
+ www/themes/$themename/
+
+The main CSS file that automatically gets included is ::
+
+ www/themes/$themename/scuttle.css
+
+Several template files in SemanticScuttle include image files. If they do not
+exist in your theme, the default ones are used automatically.
+Note that this is not true for images that are specified in the CSS files.
+
+
+Template files
+--------------
+The templates of the default file are located in ::
+
+ data/templates/default/
+
+You may put your theme template files into ::
+
+ data/templates/$themename/
+
diff --git a/src/SemanticScuttle/Model/Template.php b/src/SemanticScuttle/Model/Template.php
index ff5fbbe..234e23f 100644
--- a/src/SemanticScuttle/Model/Template.php
+++ b/src/SemanticScuttle/Model/Template.php
@@ -76,6 +76,9 @@ class SemanticScuttle_Model_Template
* Sets variables and includes the template file,
* causing it to be rendered.
*
+ * Does not take care of themes and so.
+ * The include path must be set so the correct theme is used.
+ *
* @return void
*/
public function parse()
diff --git a/src/SemanticScuttle/Model/Theme.php b/src/SemanticScuttle/Model/Theme.php
new file mode 100644
index 0000000..65861b8
--- /dev/null
+++ b/src/SemanticScuttle/Model/Theme.php
@@ -0,0 +1,97 @@
+
+ * @license AGPL v3 or later http://www.gnu.org/licenses/agpl.html
+ * @link http://sourceforge.net/projects/semanticscuttle
+ */
+
+/**
+ * A theme, the visual representation of SemanticScuttle.
+ *
+ * @category Bookmarking
+ * @package SemanticScuttle
+ * @author Christian Weiske
+ * @license AGPL v3 or later http://www.gnu.org/licenses/agpl.html
+ * @link http://sourceforge.net/projects/semanticscuttle
+ */
+class SemanticScuttle_Model_Theme
+{
+ /**
+ * Theme name. Also the path part of template and resource files
+ *
+ * @var string
+ */
+ protected $name = null;
+
+ /**
+ * Local path to the www themes directory.
+ * Needs to have a trailing slash.
+ *
+ * @var string
+ */
+ protected $wwwThemeDir = null;
+
+
+
+ /**
+ * Create a new theme instance.
+ *
+ * @param string $name Theme name "data/templates/(*)/"
+ */
+ public function __construct($name = 'default')
+ {
+ $this->name = $name;
+ $this->wwwThemeDir = $GLOBALS['wwwdir'] . '/themes/';
+ //TODO: implement theme hierarchies with parent fallback
+ }
+
+
+
+ /**
+ * Returns the URL path to a resource file (www/themes/$name/$file).
+ * Automatically falls back to the parent theme if the file does not exist
+ * in the theme.
+ *
+ * Must always be used when adding i.e. images to the output.
+ *
+ * @param string $file File name to find the path for, i.e. "scuttle.css".
+ *
+ * @return string Full path
+ */
+ public function resource($file)
+ {
+ $themeFile = $this->wwwThemeDir . $this->name . '/' . $file;
+ if (file_exists($themeFile)) {
+ return ROOT . 'themes/' . $this->name . '/' . $file;
+ }
+
+ $defaultFile = $this->wwwThemeDir . 'default/' . $file;
+ if (file_exists($defaultFile)) {
+ return ROOT . 'themes/default/' . $file;
+ }
+
+ //file does not exist. fall back to the theme file
+ // to guide the theme author a bit.
+ // TODO: logging. in admin mode, there should be a message
+ return ROOT . 'themes/' . $this->name . '/' . $file;
+ }
+
+
+
+ /**
+ * Returns the theme name.
+ *
+ * @return string Theme name
+ */
+ public function getName()
+ {
+ return $this->name;
+ }
+}
+?>
\ No newline at end of file
diff --git a/src/SemanticScuttle/Service/Template.php b/src/SemanticScuttle/Service/Template.php
index efa8d28..b5d4cfa 100644
--- a/src/SemanticScuttle/Service/Template.php
+++ b/src/SemanticScuttle/Service/Template.php
@@ -14,6 +14,7 @@
*/
require_once 'SemanticScuttle/Model/Template.php';
+require_once 'SemanticScuttle/Model/Theme.php';
/**
* SemanticScuttle template service.
@@ -38,6 +39,14 @@ class SemanticScuttle_Service_Template extends SemanticScuttle_Service
*/
protected $basedir;
+ /**
+ * The template theme to use.
+ * Set in constructor based on $GLOBALS['theme']
+ *
+ * @var SemanticScuttle_Model_Theme
+ */
+ protected $theme;
+
/**
@@ -64,6 +73,8 @@ class SemanticScuttle_Service_Template extends SemanticScuttle_Service
protected function __construct()
{
$this->basedir = $GLOBALS['TEMPLATES_DIR'];
+ $this->theme = new SemanticScuttle_Model_Theme($GLOBALS['theme']);
+ //FIXME: verify the theme exists
}
@@ -74,19 +85,33 @@ class SemanticScuttle_Service_Template extends SemanticScuttle_Service
* @param string $template Template filename relative
* to template dir
* @param array $vars Array of template variables.
+ * The current theme object will be added
+ * automatically with name "theme".
*
* @return SemanticScuttle_Model_Template Template object
*/
- function loadTemplate($template, $vars = null)
+ public function loadTemplate($template, $vars = null)
{
if (substr($template, -4) != '.php') {
$template .= '.php';
}
+
+ $oldIncPath = get_include_path();
+ set_include_path(
+ $this->basedir . $this->theme->getName()
+ . PATH_SEPARATOR . $this->basedir . 'default'
+ //needed since services are instantiated in templates
+ . PATH_SEPARATOR . $oldIncPath
+ );
+
+ $vars['theme'] = $this->theme;
$tpl = new SemanticScuttle_Model_Template(
- $this->basedir .'/'. $template, $vars, $this
+ $template, $vars, $this
);
$tpl->parse();
+ set_include_path($oldIncPath);
+
return $tpl;
}
}
diff --git a/src/SemanticScuttle/header.php b/src/SemanticScuttle/header.php
index 098e5c3..6c0d4df 100644
--- a/src/SemanticScuttle/header.php
+++ b/src/SemanticScuttle/header.php
@@ -18,9 +18,12 @@
if ('@data_dir@' == '@' . 'data_dir@') {
//non pear-install
$datadir = dirname(__FILE__) . '/../../data/';
+ $wwwdir = dirname(__FILE__) . '/../../www/';
} else {
//pear installation; files are in include path
$datadir = '@data_dir@/SemanticScuttle/';
+ //FIXME: when you have multiple installations, the www_dir will be wrong
+ $wwwdir = '@www_dir@/SemanticScuttle/';
}
if (!file_exists($datadir . '/config.php')) {
diff --git a/www/ajaxGetTitle.php b/www/ajaxGetTitle.php
index b4f44ca..8e5d92c 100644
--- a/www/ajaxGetTitle.php
+++ b/www/ajaxGetTitle.php
@@ -38,9 +38,12 @@ function getTitle($url) {
preg_match_all('/(.*)<\/title>/si', $html, $matches);
$title = $matches[1][0];
+ $encoding = 'utf-8';
// Get encoding from charset attribute
preg_match_all('/<meta.*charset=([^;"]*)">/i', $html, $matches);
- $encoding = strtoupper($matches[1][0]);
+ if (isset($matches[1][0])) {
+ $encoding = strtoupper($matches[1][0]);
+ }
// Convert to UTF-8 from the original encoding
if (function_exists("mb_convert_encoding")) {
diff --git a/www/jsScuttle.php b/www/jsScuttle.php
index 3ca41ec..de97fd2 100644
--- a/www/jsScuttle.php
+++ b/www/jsScuttle.php
@@ -3,6 +3,7 @@ $GLOBALS['saveInLastUrl'] = false;
$httpContentType = 'text/javascript';
require_once 'www-header.php';
require_once 'SemanticScuttle/functions.php';
+$theme = new SemanticScuttle_Model_Theme($GLOBALS['theme']);
$player_root = ROOT .'includes/player/';
?>
@@ -62,7 +63,7 @@ function isAvailable(input, response){
username = username.trim();
var availability = document.getElementById("availability");
if (username != '') {
- usernameField.style.backgroundImage = 'url(<?php echo ROOT; ?>images/loading.gif)';
+ usernameField.style.backgroundImage = 'url(<?php echo $theme->resource('images/loading.gif'); ?>)';
if (response != '') {
usernameField.style.backgroundImage = 'none';
if (response == 'true') {
@@ -110,7 +111,7 @@ function getNewPrivateKey(input, response){
function getTitle(input, response){
var title = document.getElementById('titleField');
if (title.value == '') {
- title.style.backgroundImage = 'url(<?php echo ROOT; ?>images/loading.gif)';
+ title.style.backgroundImage = 'url(<?php echo $theme->resource('images/loading.gif');?>)';
if (response != null) {
title.style.backgroundImage = 'none';
title.value = response;
diff --git a/www/icon.png b/www/themes/default/icon.png
similarity index 100%
rename from www/icon.png
rename to www/themes/default/icon.png
diff --git a/www/images/b_edit.png b/www/themes/default/images/b_edit.png
similarity index 100%
rename from www/images/b_edit.png
rename to www/themes/default/images/b_edit.png
diff --git a/www/images/bg_admin.png b/www/themes/default/images/bg_admin.png
similarity index 100%
rename from www/images/bg_admin.png
rename to www/themes/default/images/bg_admin.png
diff --git a/www/images/bg_bar.png b/www/themes/default/images/bg_bar.png
similarity index 100%
rename from www/images/bg_bar.png
rename to www/themes/default/images/bg_bar.png
diff --git a/www/images/bg_header.png b/www/themes/default/images/bg_header.png
similarity index 100%
rename from www/images/bg_header.png
rename to www/themes/default/images/bg_header.png
diff --git a/www/images/bg_sidebar.png b/www/themes/default/images/bg_sidebar.png
similarity index 100%
rename from www/images/bg_sidebar.png
rename to www/themes/default/images/bg_sidebar.png
diff --git a/www/images/loading.gif b/www/themes/default/images/loading.gif
similarity index 100%
rename from www/images/loading.gif
rename to www/themes/default/images/loading.gif
diff --git a/www/images/logo.png b/www/themes/default/images/logo.png
similarity index 100%
rename from www/images/logo.png
rename to www/themes/default/images/logo.png
diff --git a/www/images/logo_24.gif b/www/themes/default/images/logo_24.gif
similarity index 100%
rename from www/images/logo_24.gif
rename to www/themes/default/images/logo_24.gif
diff --git a/www/images/rss.gif b/www/themes/default/images/rss.gif
similarity index 100%
rename from www/images/rss.gif
rename to www/themes/default/images/rss.gif
diff --git a/www/images/thumbs_up.orig.png b/www/themes/default/images/thumbs_up.orig.png
similarity index 100%
rename from www/images/thumbs_up.orig.png
rename to www/themes/default/images/thumbs_up.orig.png
diff --git a/www/images/vote-against-voted.png b/www/themes/default/images/vote-against-voted.png
similarity index 100%
rename from www/images/vote-against-voted.png
rename to www/themes/default/images/vote-against-voted.png
diff --git a/www/images/vote-against.png b/www/themes/default/images/vote-against.png
similarity index 100%
rename from www/images/vote-against.png
rename to www/themes/default/images/vote-against.png
diff --git a/www/images/vote-for-voted.png b/www/themes/default/images/vote-for-voted.png
similarity index 100%
rename from www/images/vote-for-voted.png
rename to www/themes/default/images/vote-for-voted.png
diff --git a/www/images/vote-for.png b/www/themes/default/images/vote-for.png
similarity index 100%
rename from www/images/vote-for.png
rename to www/themes/default/images/vote-for.png
diff --git a/www/scuttle.css b/www/themes/default/scuttle.css
similarity index 100%
rename from www/scuttle.css
rename to www/themes/default/scuttle.css
diff --git a/www/themes/testdummy/images/logo.png b/www/themes/testdummy/images/logo.png
new file mode 100644
index 0000000..4a8f8ba
Binary files /dev/null and b/www/themes/testdummy/images/logo.png differ
diff --git a/www/themes/testdummy/scuttle.css b/www/themes/testdummy/scuttle.css
new file mode 100644
index 0000000..c62cd19
--- /dev/null
+++ b/www/themes/testdummy/scuttle.css
@@ -0,0 +1,12 @@
+@import url(../default/scuttle.css);
+
+body {
+ background-color: #FEA;
+}
+
+html > body h1 {
+ background: url('images/logo.png') no-repeat 10px;
+}
+div#header {
+ background: #FEA;
+}