Photobooth gallery plugin for WordPress

Documentation of Photobooth Deluxe
As of: 07/2019

What exactly does the Photobooth Gallery plugin for WordPress do?

Short and sweet: It allows a DSGVO compliant online gallery where each guest can only access the images for which he knows the so-called FotoPIN.

The FotoPIN is usually a combination of 3 letters and 5 numbers (eg ABC12345 or WZQ22521). Every jpg, gif, png or mp4 file gets this FotoPIN as part of the filename.

In DSLRRemotePro this is done fully automatically via the {uid} = uniqueID token.

If the file name is 20181105_113500_WZQ22521.jpg and the guest enters WZQ22521 in the search window of the online gallery, then he will find exactly this image.

 

Will the file name be one Gallery code extended, then the guest can only view his picture and the client can view and download all pictures with a code.

20181105_113500_MUT05112_WZQ22521.jpg
20181105_121131_MUT05112_UZP65482.jpg
20181105_131116_MUT05112_BVM62214.jpg

MUT05112 is the gallery code for all three images.
WZQ22521, UZP65482 and BVM62214 are the FotoPINs for the three individual photos.

This is what it looks like in practice:

https://www.photobooth-deluxe.de/bilder-ausgabe/
The PIN for the overall gallery access is: ABC54321

 

search

 

Results page

1. Installation of the plugin in WordPress

1.1. Upload and activate the plugin

  1. Navigate in the WordPress backend under Plugins> Installed Plugins
  2. Now click on the "Install" button and then on "Upload Plugin"
  3. Now click on "Select file", select the "photobooth-gallery.latest.zip" file on your computer and click on "Install now"
  4. The plugin will now be uploaded and installed automatically
  5. To activate the plugin, click on "Activate this plugin" at the end

1.2. Verify entry of serial number / plugin

With your purchase of the plugin, you will receive a personal license key and an order ID for the selected verified domain and the license duration you have chosen.

  1. In your WordPress backend, navigate to Photobooth Gallery> General Settings
  2. Enter the license key and the order ID from the order email in the fields provided License key and Purchase ID and click "Refresh" on the right to save

2. Configuration of the Photobooth Gallery plugin

2.1 General Settings

The following settings are under Photobooth gallery > General Settings to find.
To save the entries, click on "Update" on the right.

2.1.1. 

If this option is activated, we will receive an email from your WordPress in case of an error. In addition to the error message, this email contains the system information from above and the current log file. It will help you to handle it better and identify bugs.


2.1.2. License key

With your purchase of the plugin, you will receive a personal license key and an order ID for the selected verified domain and the license duration you have chosen.

Enter the license key and the order ID from the order email in the fields provided License key and Purchase ID on.


2.1.3. Logfile prefix

The plugin stores in the logfile various information (DSGVO compliant) about the usage. in The Field Logfile prefix a prefix must be specified for the file name. This prevents unauthorized access to the log file.


2.1.4. Logfile location

This area displays the current size and status of the log file. Via the link next to it you can call or save the current log file.


2.1.5. Regular upload folder scan

Yes means that every 5/15/30 minutes (depending on the Scan Interval set) automatically searches for new images in the upload folder and imports them into WordPress Media Management. The import of new files is also triggered when a previously unknown FotoPIN is entered.


2.1.6. Maximum Social Media Share Age

Minimum age of the most recent access to a shared file before it can be deleted from the library. Standard: 30 days

This feature prevents the share links still active from being invalidated. By default, a split image from the library can not be deleted unless someone has clicked on the shared link for 30 days.


2.1.7. Activate Auto Clean Up

The function Auto Clean Up allows you to delete pictures automatically after a certain time from the media library and thus also the online gallery. So you do not have to worry about the "space on the web space" anymore.


2.1.8. Enable webhook for update

If this function is activated, a URL appears with which the upload scan can be activated manually (independent of the selected scan interval).


2.1.9. Advanced GEO data tracking

If this function is activated, an API key must be entered by www.ipstack.com. This can be used up to 10,000 requests per month free of charge.

The information will be used for the DSGVO compliant usage statistics of the gallery. Instead of the IP address, the geographical region of this IP address is stored. From this information, no conclusions can be drawn to individual users. However, a geographical distribution display of accesses is nevertheless possible.


2.1.10. Allowed multimedia files

This determines which file types are allowed in the gallery.
Available are JPG, GIF, PNG and MP4.


2.1.11. Delete multimedia files

If so, then the uploaded images and video data will be deleted from the import folder after successful import into the WordPress library.


2.1.12. Clean up the library ATTENTION !!!

This is the inverse of data import. All gallery pictures (also divided) from the WordPress library will be deleted and the original pictures will be copied back to the import folder.
With this feature ALL imported gallery pictures and videos will be removed from the library and they will NOT be IMPORTED with the same file name.

This function should be used with the utmost care.


2.1.13. Pictures transmission

Click on Scan now activates the import process. This is the same action at the regular upload folder scan and at the Webhook URL is performed.

2.2. Multi-event configuration

Note: Normally, only a single configuration needs to be created for all events. It is NOT necessary to create a custom configuration for each Photobooth deployment.
But do you want to create a different configuration for an event that has nothing to do with your normal setting? No problem.

click on Photobooth Gallery> Configurations

Now a new page opens, where after the plugin installtion a default Configuration is created.

Click on default or Add New come to the settings that can be made per configuration.

2.2.1. Media folder

The plugin automatically detects the server path of your WordPress installation. Enter in the text line only the desired subfolder (eg pictures or gallery) in which your pictures to be imported are to be stored. If the option Create media folder automatically to the right is set to Yes, then this folder will be created automatically.

Please enter only one folder name and no folder structure. This is NOT necessary for the operation of the gallery.

It is located in the wp-content subfolder of the current WordPress installation.

Ideally, an FTP user is now created for this folder. This is needed to transfer the data from the Photobooth to the online gallery.

2.2.2. Regular expression

Each image must be loaded into the gallery with a unique code (FotoPIN). With Regular Expression, you can set your personal code order. You can choose between letters [AZ] and numbers [0-9]. The Breeze {uid} = uniqueID consists of 3 letters followed by 5 numbers. The regular expression looks like this: [AZ] [AZ] [AZ] [0-9] [0-9] [0-9] [0-9] [0-9].

The Breeze Token {uid2} with 5 letters and 3 numbers must be [AZ] [AZ] [AZ] [AZ] [AZ] [0-9] [0-9] [0-9].
The number of digits specified in the regular expression determined the autosubmit of the input field.
Note: Only capital letters may be used (the input field automatically converts lowercase letters to uppercase letters).

2.2.3. Admin code

For direct moderation of the online gallery there is the possibility to delete media files (pictures / videos) directly in the frontend of the website. This must be in the backend under the area Admin code a personal code can be entered.

Go to the gallery of the event via the gallery code or a photo pin and attach the following addition to the URL: ? PBGADMIN = Admin Code

Again, of course, the personal "AdminCode" must be used. If the URL is now called up, you will get an overview of all files that match the FotoPIN. In addition, each picture has a small checkbox. If this is activated, it can be confirmed by confirming the new option in the frontend Delete selected pictures the selection will be permanently deleted. Of course, it is possible to select and delete multiple media files at the same time.

Gallery access with admin code is not recorded in the statistics.

2.2.4. Wildcard for the code field

Here you can specify a text that will be displayed later on your website in the image search screen. For example, we recommend "Please enter the FotoPIN here".

2.2.5. Activate Preview Gallery

Activates a new shortcode that displays the complete gallery of this configuration without entering any code. Please note DSGVO!
This function allows eg to monitor several events at the same time, as all images read in via this gallery configuration are displayed independently of the photo-pin.

2.2.6. Autoscroll on click

The browser scrolls back to the main view after loading the clicked image. Useful when using a gallery code in the mobile view.

2.2.7. Allow direct code entry

Allows you to enter the code via the URL. The code must be entered as follows: www.domain.de/mein-beitrag/pg-code/{der-code}

This function is necessary if the picture is to be called directly, eg via a dynamic QR code.

2.2.8. Enable social media

If the function is activated, five new input blocks appear in the configuration.

2.2.8.1. Headline via social media links

Heading over the social media links

2.2.8.2. Subject for sharing via social media

Preset Subject / Subject / Title when sharing an image

2.2.8.3. Description for social media

Preset body / text when splitting an image

2.2.8.4. Set the view page

For the pictures to be shared, the following shortcode must be used

be inserted in a page. Once you have inserted the shortcode, please select the appropriate page here. Please adjust the optionalparameter settings and anchor according to this configuration. 

2.2.8.5. Social media buttons

The following interactions are possible and can be made available to guests:

  • download
  • Download Gallery (Download all images as ZIP file.) This feature is not available on all systems and therefore not a guaranteed feature.)
  • e-mail
  • Facebook
  • Facebook Messenger (mobile only)
  • Google Plus
  • Linked-In
  • Pinterest
  • Twitter
  • Whatsapp

2.2.9. iOS Video Shipping E-Mail Address

Due to the limitations of downloading MP4 videos on iOS devices (Iphone, iPad), these video files are sent to the user via email. Please enter here the sender e-mail address from which you would like to send the e-mails. So that emails sent in this way do not end up in spam, please use an e-mail address with the current website domain.

2.2.10. Introtext for the form

To place a headline, text or pictures directly above the form for entering the FotoPIN, this text box can be used.

2.2.11. Error message for wrong code input

The plugin automatically checks whether the entered FotoPIN is valid and that a file containing this information (pin = part of the file name) can be found in the library. If the PIN is entered incorrectly or if there is no picture with this PIN, this text will be displayed. This can eg "Attention! The code you entered does not seem to be correct or the image is not online yet. "

2.2.12. Enable IP blocking

With the IP-Blocker the plugin offers the possibility to block an IP address if too many failed attempts. Here you can specify how many failed attempts are allowed within a certain period of time. A setting of a period of time in seconds and unsuccessful attempts within this time can be entered here. In the wrong Note text if IP was temporarily locked a message can be issued to the user.

2.3. Masterkey / gallery code

A masterkey, also called gallery code, is used to work with a single code all pictures to retrieve an event.

The prerequisite for this is that every uploaded file has this code as part of the file name.
From Breeze DSLRRemotePro 3.7.2 you can do this function File => Photobooth event info... used.

The following example uses the field with Event name used to set the master key / gallery code.
If Martina and Tom marry on 03.02.2018, then the masterkey is MUT03022 for Martina and Tom and the first 5 digits of the date.

The content of the field Event name can now be used with the {eventName} token in the file name. (see chapter 4)

3. Include the search mask in a WordPress page

3.1. Using a shortcode

The shortcode to be inserted is at the top of every single configuration manual to find.

The parameter anchor is optional and can be deleted if it is not used.

Example of the standard shortcode:

If this shortcode is inserted on a WordPress page, the input mask for the gallery appears here.

3.2. Customize the layout

Basically, it is possible to edit all the elements that you get displayed in the frontend. All you have to do is enter the customized lines of code in the appropriate css area.

 

Usually you can find this either under:
Design> Customizer> Additional CSS

 

... or the theme used has its own area for it. In addition, there are also free plugins that allow a so-called custom css area.

 

Design adjustments can be made at the certified agency www.codevisio.io let implement.

4. Statistical evaluation of events

From version 3.1. there is a comprehensive statistics module in the online gallery.
With the installation of version 3.1. will automatically create a page named photobooth-gallery-statistics-page created.
When calling, you have to pass as parameter / pg-code / CODE /. Instead of CODE you enter the event code eg ABC12345.
The statistics then only consider data belonging to this event code.
 
The following URL shows statistics with sample values: https://demo.photobooth-deluxe.de/photobooth-galerie-statistik-seite/
 
ATTENTION: This page is automatically overwritten with each update to insert new values.
Own modifications are then lost. The remedy here is to copy the page and manually copy changes in new versions. 

 

 
data Source
1. The DSLRRemotePro XML files ([XML]) written with each sequence.
2. Social Media interactions ([Social Media]) via the online gallery
3. The interactions on the Gallery (User Logfile) ([Gallery])
 
Elementor widgets
1. Number Widget
2. Progress Bar widget
3. Image Widget
 
Combinations in the widgets
View Type (Always works in conjunction with a data source)
Shared, Viewed: Used for social media interactions (origin 2) to distinguish between views (who viewed my shared image) and shares (who shared a image)
 
Unique: Here, all views are unique, ie multiple views from origin 2 are only counted once (Unique Downloads: How many different images have been downloaded)
 
Average: Uses the event runtime (See photobooth-statistics-event-duration) to modify data from origin 3.
Works only with XML data
 
Image Widget
{Size} can be used to calculate the calculated number (most frequent photo) (in the caption)
 
shortcodes
Date shortcodes
1. photobooth-statistics-sharing-from "Date the first time a picture / video was shared / watched"
2. photobooth-statistics-sharing-to "Date the last time a picture / video was shared / viewed"
3. photobooth-statistics-event-from "Start date of the event based on the date of the first XML file of the event"
4. photobooth-statistics-event-to "End date of the event based on the date of the last XML file of the event"
 
The following parameters can be used:
- date-format: Formats the date according to http://php.net/manual/de/function.date.php
- the-code: If a fixed code is required, otherwise the / pg-code / parameter is used, or no code at all
 
Event shortcodes
1. photobooth-statistics-event-duration "Calculates the time between start and end date of the event in seconds and returns a formatted text, or the time in seconds (see parameters)"
The following parameters can be used:
- the-code: If a fixed code is required, otherwise the / pg-code / parameter is used, or no code at all
- format: Should the output be reformatted in days, hours and minutes (default: true), otherwise seconds will be returned
 
2. photobooth-statistics-event-profiles "Displays the profiles used and their frequency for the event in a small table"
The following parameters can be used:
- class: The CSS class of the table
- the-code: If a fixed code is required, otherwise the / pg-code / parameter is used, or no code at all

5. Settings in DSLR RemotePro / NK Remote

Step 1: Define the filename of the single images in Breeze

in the menu File => Preferences will the Filename prefix eg with the value% d_% t_ {eventName} _ {uid} _ pre-assigned.
% d = Translated by the photo-smoothing software into the current date in the form YYYYYMMDD.
% t = Is being converted by the Photobooth software into the current time HHMMSS.
{eventName} is the value of the event_name field from the Menu File => Photobooth event info ... (the three LargeLetters and five numbers are the so-called master key / gallery code with which all pictures of the event can be viewed).
As a rule, I define the gallery code from the name and date of the event. So if Martina and Tom marry on 3.2.2018, then my gallery code is MUT for MArtina Und Tom and 03022 are the first 5 digits of the date.
The entry {uid} is replaced by the photobooth software at each sequence by a new random code which also consists of three letters and five numbers.

For a 4-collage, the names of the individual shots are as follows:

20180203_201500_MUT03022018_ABC12345_01.jpg
20180203_201500_MUT03022018_ABC12345_02.jpg
20180203_201500_MUT03022018_ABC12345_03.jpg
20180203_201500_MUT03022018_ABC12345_04.jpg

In Advanced Settings load the desired profile and then under Output Settings as filename% d_% t_ {eventName} _ {uid} in the field Filename for JPEG copy of output enter.

In the above example, the name of the final file in the prints folder is then 20180203_201500_MUT03022018_ABC12345.jpg

Note: If the time of the file in the Prints folder differs from the time of the individual pictures, the time of the camera does not match the computer time. The file in the print folder uses the camera time.
In the DSLRRemotePro menu Camera => Set date / time and owner string the camera can be synchronized with the computer.

6. Logfile

For each action, an entry is written to a log file. This is located in the respective media folder and is named "PBG_Protokoll.log".

 

The structure of the log file is:

1st year (4 digits) - month (2 digits) - day (2 digits)
2nd hour: minute: second
3rd action
4. Photo Pin
5.File name of the image
6. Hashed file name of the image for share actions

 

Examples of log entries:

 

Display the search mask:
"2017-06-12"; "16:58:48", "display form"; ""; ""; ""

Display of the results page with the image overview:
"2017-06-12"; "16:58:56"; "Media Overview (Page 1)"; "BNT31396"; ""; ""

Copy the image to the sharedImages folder:
"2017-06-12"; "10:58:00"; "file copied"; "BNT31396"; "pbd_BNT31396.jpg"; "b94d750b838f1bb44e85960524a6b03b.jpg"

Download the picture:
"2017-06-12"; "10:58:00"; "Download"; "BNT31396"; "pbd_BNT31396.jpg"; "b94d750b83 f1bb44e85960524a6b03b.jpg"

Display a file:
"2017-06-12"; "16:58:57", "display media"; "BNT31396"; "pbd_BNT31396.jpg"; "b94d750b838f1bb44e85960524a6b03b.jpg"

Share action of a file on the specified channel:
"2017-06-11"; "10:17:40"; "Share: StumbleUpon"; "XYZ12345"; "XYZ123456.mp4"; "8b31b3d5db3f92b9910cf51a901e7fd7.mp4"
"2017-06-11"; "10:51:41"; "Share: Email"; "CAA39373"; "150221_194002_CAA39373.jpg"; "e3752cd3c2ff833b27127336173f62ff.jpg"

7. Automatic Upload with UploaderPro

Version 3.1.2 of the online gallery has developed an HTTP Uploader that automatically transfers the necessary files to the gallery.
So it will be NO FTP user and no additional software needed.

The UploaderPro can be placed in the autostart and automatically detects in which folder DSLRRemotePro stores the pictures, XML files, videos and Co. For other software products, the folders to be monitored can be specified in the Settings.ini file.
If a new file appears in the folder to be monitored, it will be transferred to an upload queue after a preset waiting time. This ensures that even in the event of a power outage or unstable Internet connection, no files are lost or uploaded.

It can also be set, which files should be transferred. In the default configuration after the download (where will be the same) the following settings are made:
= True Prints
Originals = true
XML = true
MP4 = true
GIF = true
Processed = true
So all final results generated by DSLRRemotePro will be transferred.

 

Download the UploaderPro

 In the WordPress backend, there is the section Webhook Uploader under the general Photobooth gallery settings.
There, under Web upload password, the randomly assigned can be changed into its own. Important: Only letters (lowercase) + numbers.

To the right, the target configuration can be selected for which the uploader should be valid. Since each configuration has its own upload folder in the file system, the UploaderPro knows in which directory it should save the files.

Click on Download UploaderPro to download a zip file. These just unpack somewhere on the photo box and the UploaderPro.exe To run. A link of this EXE file can also be placed in the Windows Startup.
In Settings.ini can still be made some settings. The default settings are chosen so that all results of DSLRRemotePro are transferred to the gallery.

Adjust the UploaderPro settings

The UploaderPro.exe folder also contains a Settings.ini file. In each case the Settings.ini from the folder of the EXE file is used.
So you can save on a photo box several different configurations in different folders.
In this Settings.ini the following settings can be changed:

Silent = True UploaderPro only starts as a small icon in the Traybar
Silent = False UploaderPro starts with the visible upload status

Prints = true / false; Upload the collages from the Prints subfolder (the default)
Originals = true / false; Original files of the camera
XML = true / false; XML files generated with each sequence (important for statistics)
MP4 = true / false; MP4 videos from the prints or gif subfolder
GIF = true / false; GIFs from the prints or GIF subfolder
Processed = true / false; Jpg files from the processed subfolder

For each upload type, a delay can be set. The value is given in seconds.
This is important, for example, if a file is still being edited by an external script such as Breeze2GSW.

Prints_Delay = 3
Originals_Delay = 30
XML_Delay = 3
MP4_Delay = 3
GIF_Delay = 3
Processed_Delay = 3

If you want to transfer files with the help of the UploaderPro to the gallery coming from another source (eg DSLRBooth, Breeze HotfolderPrint ..) then you can create any number of so-called watchfolders. So folders that are monitored by the UploaderPro on new files. The following block must be created completely for each folder.

[WatchFolder_name1]
Active = true / false
\ \ Photos: localpath = C
Filter = *. *
Subdirs = true / false
Delay = 3
ExcludePath = optional
IncludePath = optional

[WatchFolder_name1]; In the square brackets any name can be entered. Please do not use spaces and special characters.

Active = true / false; Only if true, this folder is monitored.
Localpath = c: \ yourpath; The local folder to be monitored
Filter = *. *; Definition of certain file types to be uploaded. *. * stands for all files in the folder. * .jpg = jpg files only
Subdirs = true; Specifies whether subfolders (eg date folders) should also be monitored.
Delay = 3; Delay in seconds before adding a new file to the queue.
Excludepath = prints | proc; Folders containing the name prints or proc are ignored. Multiple folders can be accessed by | be separated.
Includepath = prints | proc; Folders containing the name prints or proc will be uploaded, the rest will be ignored. Multiple folders can be accessed by | be separated.

Please note that includepath and excludepath are mutually exclusive.

 

Known Issues:

Auto Optimizer Plugin

The red marked functions must NOT be activated.

WP Hide Plugin Updates and Warnings
This plugin causes the online gallery to NOT be activated.
Bootstrap version conflict
In rare cases, it may happen that  bootstrap is installed by several plugins. In this case, you can circumvent any version conflicts by disabling Bootstrap in the Photobooth Gallery Plugin. This feature is not suported !!!

Use with DSLRBOOTH

With DSLRBooth the usage looks like this:

 

Alternative A:
Unfortunately, the file name of DSLRBooth can not be influenced at the moment. It consists of date_time_3digitNumber.jpg.
You can use this relatively long file name as a code and print it on the picture.

 

Alternative B:
With Breeze Hotfolderprint you can give the files a new, shorter file name.

Also with Breeze Hotfolderprint you can print on a receipt printer the Downloadlink + FotoPin.

 

Alternative C:
DSLRBooth makes only the photo and the printout of the photo incl. Short FotoPIN is completely done by Breeze HotfolderPrint.

Then, however, each picture is printed.

Photobooth DeluxeThe ultimate photo fun for your event

Close Menu