Coppermine Photo Gallery v1.5.x: Documentation and Manual

Table of Contents

Upload troubleshooting

If you have upload issues, read this page - entirely! The Coppermine dev team considers this page to be the most important page of the entire documentation, simply because there are many different things that can go wrong when uploading. This is caused by different webserver setups mostly.

Permissions

First and foremost: Check your folder and file permission settings on the /albums, /albums/userpics, and /albums/edit directories. On *nix-driven webservers, the folder /albums and all sub-folders should usually be 777 or 755 (depending on your webserver configuration). If you don't know what we mean by 777 or 755, you need to read up the permission section (if this doesn't help, do a Google search on UNIX file permissions). Windows has a similar set of file permissions. You can usually set these permissions using an FTP client (If you don't know what an FTP client is, Google for FTP client or take a look at the list of recommended tools).

For those of you who skim over statements written in red letters, we will repeat to try to get your attention:
Yes, we are writing about something that could easily apply to you

We repeat - check/apply your permissions on the /albums, /albums/userpics, and /albums/edit directories. All should usually be 777 or 755 (depending on your webserver configuration) or whatever is needed on your webserver setup to allow the coppermine script write access.

Yes, we do want you to set the permissions of each folder even if you think you have already done this. Yes, we mean it. No, just checking permissions (i.e. looking up what your FTP client reports permissions to be) is not enough. As we said: set/apply permissions, don't just look at them.

Enable troubleshooting settings

If you are experiencing issues with coppermine's upload process, temporarily change your coppermine settings as suggested below to get more detailed error messages. This applies to all upload methods, not only HTTP uploads.

Details
Even if you have issues with batch-adding pics (or any other uploading method), you should perform the steps mentioned below that check http uploads, as http uploads are the most basic upload method that needs to work under all circumstances.
If you're going to request support on upload issues on the coppermine support board, you're requested to perform the steps mentioned below in detail.

When troubleshooting uploads in CPG 1.5, you are advised to activate 'Debug mode' in the config console. Changing this setting negates some of the error masking done in the multiple upload setting. This will allow you to access more detailed error messages.

You should try using http uploads, even if you experienced troubles using another upload method. You should get a more detailed error message if something is wrong that tells you what exactly goes wrong with your uploads. If the error message doesn't mean anything to you, search the support board for the error message you get.

If you don't get an error message at all, you probably have overloaded the server with previous attempts - please review the server-sided limitations that might apply for you.

Asking for support on upload issues

When asking for support on the coppermine forum, post a link to your site and a test user account (the test user mustn't be in the admin group!) with upload privileges, with the above mentioned settings in place - this way, supporters can see the error messages as well. Do not post debug_output unless requested. If you want fast results, you should disable admin approval for the group the test user is in, so supporters can tell instantly what is wrong without needing to double-check.

When people have issues with uploading and decide to post their question on the Coppermine support board, they usually are told to read this upload troubleshooting section. Many of them fail to do so properly, which results in frustration both for users as well as supporters.
To make this absolutely clear: the above mentioned steps are absolutely mandatory, no matter what skill level you have, no matter what upload method you have troubles with. Failing to do exactly as suggested will result in your request for help being ignored. Yes, this applies to you. We mean it!

Not sure what to do now? Read on:

Step-by-step guide when asking for support

This is a step-by-step guide that is meant to explain in a fool-proof way what settings you need to make when asking for support on the Coppermine support board.

We assume that you have applied tight permission settings, so we'll go through this a bit more complicated than actually necessary on most setups: the instructions below are meant to allow upload troubleshooting for the supporter even if the rest of users of your gallery isn't allowed to upload or if you don't even allow user registration in the first place. If you know your way around, you can of course skip the steps that explain the creation of an extra group if all your registered users are allowed to upload anyway. In the end, the important thing that counts is that the supporter can go through uploading untill he/she can see what actually goes wrong during the upload stage.

Example support request

This is how your support request posting could look like (make sure that you populated the stuff in red with actual content from your case):

I'm having issues when uploading on my Coppermine driven gallery http://example.com/my_coppermine_folder/
When using http uploads and the suggested settings for upload troubleshooting in place, I get the error message
 
[code]The text of the error message here[/code]
 
Here's the test user account data:
    Username: tester
    Password: foobar
 
I have been using the image taken from http://example.com/path/to/test/file.jpg as an example to test with.
Having done as suggested in http://forum.coppermine-gallery.net/some_forum_thread didn't work as expected: I got
[code]Some other error message[/code]
when trying that. I have no idea what else to do.
Thanks in advance for your suggestions

Error messages

Below is a list of error messages that are quite frequent. Please review this section carefully if the error message you get during upload is being mentioned here. If it is, try applying the suggested fix.

Error message: failed to create stream: Operation not permitted

Detailed error message

Impossible to move somepic.jpg to albums/userpics/
Warning: move_uploaded_file(/tmp/phpezCYKr)
[function.move-uploaded-file]: failed to create stream: Operation not permitted

The error message above of course will differ slightly from one setup to the other. The dynamic sections of the error message (that may differ) are highlighted in blue in the example, opposed to the static (unchangeable) parts of the error message that is printed in black.

Possible cause

PHP's temporary folder is missing or doesn't have the needed permissions.

Suggested fix

You should contact the admin of your webhost because you usually can't change the location of the website's temporary directory for file uploads, yourself (it is part of PHP configuration) .
If the open_basedir restriction is in effect on your site then the temp directory for file uploads should be one that you can access.

Impossible to move X to Y

Detailed error message

Impossible to move somepic.jpg to albums/userpics/XXXXX/

The error message above of course will differ slightly from one setup to the other. The dynamic sections of the error message (that may differ) are highlighted in blue in the example, opposed to the static (unchangeable) parts of the error message that is printed in black.

Possible cause

The coppermine script doesn't have permissions on the filesystem of the server to create the thumbnail or intermediate image within the specified folder

Suggested fix

Apply permissions on the albums folder and everything within it as suggested in the section Setting permissions. This error message is the most frequent one, as many users tend to skip reading the permissions section. At least when getting this error message, you should read it thoroughly.

Error message: failed to open dir: No such file or directory

Detailed error message

Warning: opendir(./albums/edit): failed to open dir: No such file or directory

Possible cause

Suggested fix

Error message: Sorry there is no album where you are allowed to upload files

Detailed error message

Sorry there is no album where you are allowed to upload files

Possible cause

Suggested fix

This error message is a soft error, i.e. it's something that is related to your Coppermine setup and means that you haven't done something that you should have done.

Error message: Allowed memory size of X bytes exhausted

Detailed error message

Fatal error: Allowed memory size of XXXXXXX bytes exhausted at (null):0 (tried to allocate XXXX bytes) in /var/www/html/include/picmgmt.inc.php

The error message above of course will differ slightly from one setup to the other. The dynamic sections of the error message (that may differ) are highlighted in blue in the example, opposed to the static (unchangeable) parts of the error message that is printed in black.

Possible cause

This error occurs when using GD and attempting to upload a high resoltuion image. It's not the size of the file that matters here; it's the number of pixels that determine memory use in GD. This is not a soft error triggered by Coppermine, but a hard error from PHP that shines through Coppermine from PHP.

Suggested fixes

There is (at least in theory) no limit in Coppermine to the file size or dimensions that the script can handle. However, there is at least one limit existing on the webserver: resizing images (to create intermediate images and/or thumbnails) consumes memory and burns CPU cylces. To prevent the server from crashing, the server admin has to restrict the amount of memory that a PHP script is allowed to consume. The error message mentioned above means that the limit imposed by the server admin has been reached, i.e. the image that the script tried to process consumed to much memory.

Error message: Exec() has been disabled

Detailed error message

Exec() has been disabled

Possible cause

php.ini allows the server administrator to disable certain functions. Usually this is the case if your server is running in safe_mode. This is not a soft error triggered by Coppermine, but a hard error from PHP that shines through Coppermine from PHP.

Suggested fix

If the server administrator has disabled exec() you will not be able to use ImageMagick.
You may try to replace exec() with passthru() in the entire core code of coppermine (not recommended) if it has not been disabled as well. Otherwise, you can't use ImageMagick and must use GD. Change Method for resizing images in config accordingly.

Error message: Not a GD extension

Detailed error message

Not a GD extension

Possible cause

The file(s) you tried to upload can not be handled using the GD ImageLibrary

Suggested fix

The GD library can only handle jpeg, png and gif files, while the ImageMagick library supports additionally bmp, psd and some other (less common) file types. However, those files are not suitable for use on the internet. Details can be found in the Allowed image types section in the config page of the docs.

Error message: Error executing ImageMagick - Return value 127

Detailed error message

The file 'albums/userpics/10001/somepic.jpg' can't be inserted in the album. Error executing ImageMagick - Return value 127

The error message above of course will differ slightly from one setup to the other. The dynamic sections of the error message (that may differ) are highlighted in blue in the example, opposed to the static (unchangeable) parts of the error message that is printed in black.

Possible cause

You haven't specified the correct path to ImageMagick, or you don't have ImageMagic at all. The first sentence of the error message is a soft error triggered by Coppermine, but the second sentence is a hard error from PHP that shines through Coppermine from PHP, with the important bit being the last sentence Return value 127.

Suggested fix

If you're sure that you actually have ImageMagick available on your server, review path to ImageMagick. If the path appears to be correct, make sure that the coppermine script has permissions to read and execute the convert executable within the ImageMagick folder. If you're not sure, switch Method for resizing images from "ImageMagick" to "GD2", then try uploading again.

Error message: PHP running on your server does not support the GD image library

Detailed error message

PHP running on your server does not support the GD image library, check with your webhost if ImageMagick is installed.

Possible cause

Your webserver doesn't come with support for the GD image library.

Suggested fix

Make sure that you fullfill the minimum requirements to run Coppermine. If GD is not available on your server, you could use ImageMagick. Ask your webhost if ImageMagick is available on your webserver.

Error message: No file was uploaded !

Detailed error message

No file was uploaded ! If you have really selected a file to upload, check that the server allows file uploads...

Possible cause

File uploads are disabled in php.ini or there is a permissions issue or there is an issue with your webserver's upload mechansim.

Suggested fix

There may be several reasons for this error message. The file you tried to upload did not "reach" the folder on the webserver where it is supposed to go. Check if there's a problem with HTTP uploads on your server - this feature may have been disabled or improperly configured. In phpinfo(), check that "file_uploads" is ON, "upload_max_filesize" is something like 2M and "upload_tmp_dir" is a valid directory! Make sure to review your file/folder permissions as well.
If the server isn't yours to administer, you may have to ask your webhost for support. Here is what you should check:

Error message: Destination directory X is not writable by the script

Detailed error message

Destination directory albums/userpics/XXXXX/ is not writable by the script

The error message above of course will differ slightly from one setup to the other. The dynamic sections of the error message (that may differ) are highlighted in blue in the example, opposed to the static (unchangeable) parts of the error message that is printed in black.

Possible cause

Permissions on file system level are not correct. In fact that's what the rant on permissions at the top of this page is about...

Suggested fix

Make sure to review your file/folder permissions. If that doesn't help, ask your webhost for support.

Server-sided restrictions

All upload methods, but particularly HTTP uploads are limited by the restrictions placed upon them in PHP's configuration.

The PHP configuration file php.ini

Please understand that the settings in php.ini can only be changed if the server is yours to administer (i.e. if you run a webserver of your own). If you are webhosted, you will have to ask your webhost if he's willing to change those settings for you, which usually equals allowing you to use more resources on the server. Usually, your webhost will not accept this for sheer economical reasons: granting you to use more resources will mean that he can host less presences on one shared server.
Please don't ask questions on the coppermine support board what the actual settings are supposed to be or how you can change them - as suggested above: you usually won't be able to change them at all when you're webhosted.
If you're actually self-hosted (which is something we can not recommend at all as running and maintaining a webserver requires constant monitoring and maintenance as well as a huge amount of experience and a high skill level), don't bother to ask trivial questions like "Where can I find my php.ini file" - if you don't know the answer to this question, you fall into the category "self-hosting not recommended due to lack of experience" and will be ignored on the coppermine support board.

Things to check

If you are webhosted, you will need to consult with your webhost regarding the following settings. You can review (although not change) those settings on your phpinfo page.

  1. max_input_time

    60 seconds is the default time limit for uploading files.
    This time limit includes the time it takes for the files to upload, so if you exceed this limit, the file will not even parse, and the browser will not get a response. You can workaround this by trying to upload smaller or fewer files, or you can try uploading over broadband. The best solution, of course, is to increase the time limit to something more in line with your needs.
  2. upload_max_filesize

    2MB is the default limit for individual files.
  3. post_max_size

    8MB is the default limit for post requests.
  4. memory_limit

    8MB is the default size. Read up Memory usage during resizing for instructions how to change this setting and circumvent the error messages related to the memory limit being reached.
  5. LimitRequestBody

    512KB default limit. (mainly an issue on Redhat/Apache systems. Found in /etc/http/conf.d)
    In general, upload_max_filesize < post_max_size < memory_limit in order for uploads to function properly. Coppermine may warn you if a file exceeds upload_max_filesize, but it cannot warn you if the total size of all the files exceeds the post limit or the memory limit.
  6. file_uploads

    This determines whether or not PHP will allow file uploads. It must be set to "On".
  7. upload_tmp_dir

    This specifies the temporary directory where PHP stores uploaded files.
    The most common issue caused by this setting is an open_basedir warning. In this situation, your server administrator has restricted the files that PHP can work with to a certain directory. If he does not create and specify a temporary directory within the open_basedir restriction, PHP will attempt to use the OS temporary directory, and it will be rebuffed by the open_basedir restriction.

Upload mechanisms/methods

Some notes about the different types of upload mechanisms available since cpg1.3.x (or better):

Multiple HTTP uploads are designed to handle a small number of files. Therefore, they are not well suited for the uploading of large numbers of files unless you are running your own webserver or have control over the php.ini configuration.

If you are looking to upload more than 15 or 20 files at a time, you should consider the batch add process or the XP Publisher utility. Each has its own drawbacks and advantages.

The batch add process is fast, but it creates quite a load on the server and, as a result, you may experience timeouts causing your uploads to terminate prematurely. XP Publisher, on the other hand, is considerably slower, but it limits the load on the server. It also circumvents many of the pitfalls caused by limitations set in the php.ini configuration by uploading each file in the batch being uploaded as an individual post request.

Other alternative upload mechanisms (like Client-based agents as JUpload or similar) may be provided as third-party contributions - you're encouraged to look at them as well, but please keep in mind that the coppermine developers can only provide limited support for third-party contributions.

Keep in mind though that before trying any alternative upload mechanism, you have to make sure that the initial upload method "http uploads" works as expected - if it doesn't, you have to fix that first; it doesn't make sense to try alternative upload mechanisms if the core upload mechanism doesn't work.

Memory usage during resizing

There is (at least in theory) no limit in Coppermine to the file size or dimensions that the script can handle. However, there is at least one limit existing on the webserver: resizing images (to create intermediate images and/or thumbnails) consumes memory and burns CPU cylces.

If the resizing process is eating up too much memory, you usually get the error message Fatal error: Allowed memory size of XXXXXXX bytes exhausted at (null):0 (tried to allocate XXXX bytes) in /var/www/html/include/picmgmt.inc.php or similar.

To prevent the server from crashing, the server admin has to restrict the amount of memory that a PHP script is allowed to consume. This is done using the parameter memory_limit.

You might be tempted to believe that the memory usage equals the file size an image consumes on file system level, but that's not the case: the common file format JPEG is compressed, so if the server loads a JPEG file into memory, it consumes much more RAM than it consumed on file system level.

To calculate the amount of memory an image uses, you simply multiply the pixel width and height, and then you multiply the result by the number of base colors (RGB - 3, CMYK - 4). Finally, you divide by 1,048,576 (220) to get the memory usage in MB.

Here are some common image resolutions and their memory use in GD (assuming RGB):

Screen resolution name Width Height Memory usage Aspect ratio
QVGA 320 x 240 0.2 MB 4 : 3
VGA 640 x 480 0.9 MB 4 : 3
SVGA 800 x 600 1.4 MB 4 : 3
XGA 1024 x 768 2.3 MB 4 : 3
WXGA 1280 x 800 2.9 MB 16 : 10
SXGA 1280 x 1024 3.8 MB 4 : 3
SXGA+ 1400 x 1050 4.2 MB 4 : 3
UXGA 1600 x 1200 5.5 MB 4 : 3
WUXGA 1920 x 1200 6.5 MB 16 : 10
QXGA 2048 x 1536 9.0 MB 4 : 3
WQXGA 2560 x 1600 11.7 MB 16 : 10
QUXGA 3200 x 2400 22.0 MB 4 : 3
QXGA 4096 x 3072 36.0 MB 4 : 3
HUXGA 6400 x 4800 87.9 MB 4 : 3
UHDTV 7680 x 4320 94.9 MB 16 : 9
WHUXGA 7680 x 4800 105.5 MB 16 : 10

Remember when using the above figures that the amount of memory being used by the rest of Coppermine must be taken into account, too.

As you can see, the memory consumption of images produced by modern digital cameras can easily be too much for your webserver to cope with, even when using single file uploads (let alone the consumption when processing several images using batch-add), so it's recommended to resize your images on your client before uploading them: if the server simply isn't capable to process the images uploaded, there's little point in blaming the script (i.e. Coppermine) or asking for support on the Coppermine support board: the Coppermine devs can not find a cure for the technology used on webservers. Use the webserver for what it has been designed to be used for; perform resources-intensive calculations (like resizing images with a high resolution) on your client.

To increase the memory limit allocation in php.ini, you must be the server's administrator. Also, .htaccess files cannot change this configuration setting, and it cannot be changed using ini_set(). This being said, most coppermine users who are on shared webhosting will not be able to change this. If you actually are the server admin, here's how to increase the memory limit:
First, you locate the following block in php.ini (if you actually are the server admin):

;;;;;;;;;;;;;;;;;;;
; Resource Limits ;
;;;;;;;;;;;;;;;;;;;

max_execution_time = 30     ; Maximum execution time of each script, in seconds
max_input_time = 60        ; Maximum amount of time each script may spend parsing request data
memory_limit = 8M      ; Maximum amount of memory a script may consume (8MB)

Now you increase the memory limit to fit your needs. 9 to 16 MB should handle most requirements.

If you are unable to change php.ini settings yourself, you can always ask your server administrator to change this for you. However, most administrators (especially on shared webhosting) will be reluctant to do so, as this setting will affect everyone on a shared server. A higher memory limit requires reducing the number of people who can be hosted on the same server in order to maintain server stability. This reduces profitability, etc.

Do not ask questions on the Coppermine support board how to configure your webserver; it's beyond the scope of the Coppermine support board to explain webserver setups. Usually (if you're on shared webhosting, which is the case for the vast majority of Coppermine users), you can't change webserver settings anyway. Only the person who actually administers the webserver (i.e. the webhost's admin) can change webserver settings.
Therefore, you better ask your webhost for support if you have issues with ressource limitations or other questions that related to webserver setup. If you're self-hosted (which is something the coppermine dev team doesn't recommend), you should read up your issue in the documentation that comes with your webserver.