Rain variables

[Sbgodin]

Hi all!

I wish to add the ability to define where to store all writable files. I set up two variables for RainTPL. This way, it will be possible to install/setup Shaarli in two separate directory : one with write access, one with read only access.

I think it would be neat for package maintainer and, maybe, to have a multi-user deployment.

Would you like to check this, at least, the following ways:

• Is the idea valuable?
• Is there any error in it?
• Do you like my implementation?

Thanks in advance.

[e2jk]

I'm not sure I see the value in the variable for the template files, as those don't need write access.

But I second the idea of write vs. read-only access, as that is what the Debian package already performs:
The "static" files (index.php, .html template files) are installed in /usr/share/shaarli, while the "dynamic" data is stored at other places:

• data to /var/lib/shaarli/data
• cache to /var/cache/shaarli/cache
• pagecache to /var/cache/shaarli/pagecache
• raintpl temp cache to /var/cache/shaarli/tmp

In the Debian package, the paths are hardcoded (in debian/patches/install.patch, but it would be as fine to have them configurable using the config file, and Debian would provide a standard config file with these paths already set.

For completeness' sake, FYI there is a second patch debian/patches/raintpl-tmp-folder-creation.patch that uses the raintpl::$cache_dir variable instead of tmp. Seems like I hadn't noticed the duplication of that piece of code ;)

Could you increase the scope of this pull request, to also allow indicating the storage location for data, cache and pagecache? This would allow me to drop 2 patches from the package, which is great news.

[nodiscc]

Hey nice patch, I would also remove the chmod/mkdir calls from index.php, this way we can remove the need for shaarli to be able to write in it's own directory. (this has been reported sebsauvage#181).

Just create empty tmp/ and data directories in the repo with correct write permissions, so that the default setting works. (since git does not track empty directories, create a blank .gitignore in these dirs)

[Sbgodin]

I grepped all the mkdir statements, it's about : DATADIR, RAINTPL_TMP, CACHEDIR, PAGECACHE. Special mention about the french provider free.fr and the session directory to create.

@nodiscc If I follow your thoughts correctly, we would create in the repository the following directories : data, tmp, cache, pagecache. This way, we could get rid of the mkdir. Is this ok?

I added the template directory, just to be able to customize all the paths. Let's imagine that, later, templates are added. An option could allow to choose one or another, especially if Shaarli go mutli-users...

@e2jk the location of the cache, pagecache, and data were already existing as variables. As you can see on line 37 you can add DATADIR/options.php to override the values.

[nodiscc]

we would create in the repository the following directories : data, tmp, cache, pagecache. This way, we could get rid of the mkdir. Is this ok?

Yes that's what I had in mind.

just to be able to customize all the paths. Let's imagine that, later, templates are added. An option could allow to choose one or another

Very good. Same could be said for custom themes/CSS as we have already collected a few

[Sbgodin]

I added the empty directories, filling them with an htaccess denying access. I also removed the directories creation and the creation of the htaccess.

[Sbgodin]

I didn't see any problem with it. Is it ok for you that I merge it in master?

[nodiscc]

Let's do this. Thanks!