Image Directory Revamp

Tiki img directory consolidation.

Goal

• Stage 1: to have a clean, organized structure to find things where they are expected - DONE
• Stage 2: delete unnecessary, unused files - partly DONE, still many unused files left

Timeline

• lets agree first on how it should be, than figure out how to do
• March 2nd - 4th: make it happen for Tiki9 (trunk now)
• Document the changes made: Update docs for Tiki 9 -> Tiki9

Number of references in all the files

Some grepping stats (revision 39998 after clearing Tiki cache):

luci@w7-vbox-ubuntu:/var/www/tikitrunk$ grep -Ro --exclude-dir=\.svn 'img\/' * | wc -l
1029
luci@w7-vbox-ubuntu:/var/www/tikitrunk$ grep -Ro --exclude-dir=\.svn 'images\/' * | wc -l
1448
luci@w7-vbox-ubuntu:/var/www/tikitrunk$ grep -Ro --exclude-dir=\.svn 'pics\/' * | wc -l
4574

Revamped img dir structure proposal

• img/
  • img/avatars/
  • img/flags/
  • img/icons/
    • img/icons/large/
    • img/icons/mime/
    • img/icons/sprite/
    • img/icons/svg/ (for future use of http://raphaeljs.com/icons)
  • img/smiles/
  • img/tiki/
  • img/trackers/
  • img/webmail/
  • img/wiki/
  • img/wiki_up/

Issues / Questions / Concerns

• things might get temporarily broken in trunk but on the long run we should get through this
• afraid if the "icon themes" override functionality will be preserved (see for example Strasa theme) — luci
• what happens if there is wiki page created named "images" and rewrite rules are on via .htaccess - it is very possible case. Will the images be still readable or broken ? would not it be better to use the img dir or pics dir instead ? — luci
  • OK. Just tried and it reveals, that if one creates page named "Images", he/she cannot access the created page after save using the SEFURL, because Tiki thinks it is the images/ dir and there is the index.php redirect to Tiki index page. — luci
    • luci: Only one problem remains with the images dir - now when it is gone i would expect that my test wiki page named "images" will be working but i get error instead redirecting me from http://localhost/tikitrunk/images to http://localhost/tikitrunk/images/ and the error is: "Page not found images/" and the theme is completely broken
      • gezza: on my localhost with SefURL on "tikitrunk/images" is being displayed fine
• just spotted it: what about lib/images/icons/ ? — luci
• known issue - Xavi reported his custom icons use old paths to pics/ and he gets PHP error now - will need php upgrade script created in installer/schema/ to replace the paths in tiki_preferences tool_icon

Things to Check

• Now we have just some things to check remaining:
  • rewrite rules in .htaccess
  • is there any Tiki 9 specific profile using the old paths on http://profiles.tiki.org?
  • is there any Theme on themes.tiki.org using the old paths?
  • are there any possible use cases causing trouble after upgrade?
    • custom toolbar icons created at /tiki-admin_toolbars.php get broken after update if they point to the legacy pics/icons folder. Related data is stored in tiki_preferences table with pref name tool_icons.
  • does fresh install work fine?

Overview

Important files to check

./lib/init/smarty.php:26:			'styles/strasa/pics/icons/',
./lib/init/smarty.php:27:			'styles/coelesce/pics/icons/',
./lib/init/smarty.php:28:			'styles/darkroom/pics/icons/',
./lib/init/smarty.php:29:			'styles/thenews/pics/icons/',
./lib/init/smarty.php:30:			'styles/tikinewt/pics/icons/',
./lib/init/smarty.php:31:			'styles/twist/pics/icons/',
./lib/init/smarty.php:38:			'pics/',
./lib/init/smarty.php:39:			'pics/icons',
./lib/init/smarty.php:40:			'pics/icons/mime',
./lib/init/smarty.php:41:			'pics/large',

./lib/prefs/menus.php:20:			'default' => 'pics/large',

./lib/smarty_tiki/function.icon.php:58:	$basedirs = array('pics/icons', 'images', 'img/icons', 'pics/icons/mime');
./lib/smarty_tiki/function.icon.php:71:		if ( isset($params['_defaultdir']) && $params['_defaultdir'] == 'pics/large' ) {
./lib/smarty_tiki/function.icon.php:79:		if ( $params['_defaultdir'] == 'pics/large' ) {

./lib/smarty_tiki/modifier.iconify.php 29: 	$icon = file_exists("pics/icons/mime/$ext.png") ? $ext : 'default';

33: '_id' => 'pics/icons/mime/'.$icon.'.png',

Change description

File system changes

r39999 - r40040

DB changes

No change

Background information

Directory name selection

[+]

Jyhem pointed out, that why dont we call the final directory "images" instead of "img". After some looking around and also considering the other folder names inside the Tiki installation I agree, we should call it "images". — gezza

• Why not the shorter img/ or pics/ ? — luci

• considering the points by luci and also the possible db regressions (see below), the winner is: "img" — gezza

possible DB regressions if going with 'images'

- tiki_preferences table sitelogo_src field: can use a path starting with "img/..." -> can be fixed manually in the admin panel Look&Feel or by an update script

- tiki_tracker_item_fields table value field: the path for uplocaded images to tracker items is stored here it should be updated with an sql script
- tiki_tracker_item_field_logs table value field: can contain value pointing at "img/..."
- users_users table avatarLibName field: can contain value pointing at "img/.."
- tiki_quicktags table tagicon field: can contain values pointing at "pics/.." not sure about the side effect

- tiki_secdb table filename field: can contain values, but probably irrelevant

Mass change in the code (How-to)

[+]

0: delete all cache
1: in Aptana search&replace: "images/" -> "img/"
note: using Preview function I excluded changelog.txt, robots.txt, /lib/tikihelp/menu/example.txt, lib/core/Zend......CommandMessage.php from the mass update. Not sure what to do with db/tiki_1.9to2.0.sql and db/tiki_2.0to3.0.sql. — gezza <- do nothing with them probably — luci
2: move directory content: images/ -> img/
3: in Aptana search&replace: "pics/" -> "img/"
note: using Preview function I excluded changelog.txt, robots.txt, and all under lib/jquery and lib/jquery.sheet from the mass update. — gezza
4: move directory content: pics/ -> img/

Quote from threads in devel list:

[+]

Re: [Tikiwiki-devel] img/ images/ pics/ -> 3 directories :: Can we merge?
...
Sunday, September 27, 2009 3:51:28 PM
From:	
Marc Laporte <marc@marclaporte.com>
...
View Contact
To:	Tikiwiki developers <tikiwiki-devel@lists.sourceforge.net>	
+1

That would be useful for site editors to add images in pages,
articles, etc. and add life to a site.

However, we should make sure not to rename the files after, or else
image links will be broken.

M ;-)

On Sun, Sep 20, 2009 at 12:40 PM, gezza nagy <gezzzan@yahoo.com> wrote:
> how about making the folders of the consolidated img directory available for
> use from file galleries as a system gallery? upon install by default, view
> and manage rights for the admin only
>
> thanks&cheers,
> gezza
>
>
>
> ________________________________
> From: Jonny Bradley <tw@nospaces.net>
> To: Tikiwiki developers <tikiwiki-devel@lists.sourceforge.net>
> Sent: Tuesday, September 15, 2009 4:12:49 PM
> Subject: Re: [Tikiwiki-devel] img/ images/ pics/ -> 3 directories :: Can we
> merge?
>
>
> It would be nice to get all the famfamfam ones back to their original
> names too - and remove the duplicated ones...
>
> +1 for this but with subdirs, as Nyloth suggested
>
> jb
>
> On 15 Sep 2009, at 13:09, luci aka luciash d' being wrote:
>
>> +100 to kill 'em all :)
>>
>> luci
>>
>>
>> On 09/15/2009 01:49 PM, Sylvie Greverend wrote:
>>> images was supposed to disappear - because it is an unknown source.
>>> So I
>>> think it is better not to merge but to delete the icons that are not
>>> used.
>>> pics/icons and pics/large are the famfam ones - so LGPL.
>>> Is somebody ready to grep all the icons of images to see if they are
>>> still used.
>>>
>>>
>>> On Tue, 2009-09-15 at 11:30 +0200, Nyloth wrote:
>>>
>>>> Hi Marc,
>>>>
>>>> I'm also against img + images + pics
>>>> So... moving everything into one images or pics folder is ok for me
>>>> too.
>>>>
>>>> But I would prefer to have subfolders inside, in order to separate
>>>> icons from other images and keep famfamfam icons in their own folder
>>>> to easily identify the origin of those images and their licence.
>>>>
>>>> Cheers,
>>>> Nyloth
>>>>
>>>> 2009/9/14 Marc Laporte <marc@marclaporte.com>
>>>>        Hi!
>>>>
>>>>        Any reason not to converge all images in one directory?
>>>>
>>>>        Preparing for Tiki4, some cleanup questions:
>>>>        http://dev.tikiwiki.org/Tiki4#Can_we_delete_
 

>>>>
>>>>        Thanks!
>>>>
>>>>        --
>>>>        Marc Laporte

Alias

• ImgDirectoryRevamp