Module: preformatted URLs (attachment + screenies, yay)

In the wake of boredom I have developed a quasi-useful module for G2.

Behold! The G2 preformatted URL module. While I was initially developing it for my own G2, I figured that I might as well contribute back to the project that has given me so much.

What does it do?
See: http://codex.gallery2.org/index.php/Gallery2:Modules:geturls

It adds an option to each image that reads "get item URLs". When you click it, you get a nice page that wraps the URL to your photo (either direct, or to the page it's on) in the most common formats: bbcode and HTML. See screenshot below (click):

[img]http://g2test.txtdump.com/d/22-1/g2geturls-0_8_1.png[/img]
(older 0.8.0 screenshot)

Features:

• It's a proper module. Just extract archive into your modules/ directory and install it (sits under Extra Data) through the admin interface. No need to hack up your code.
• Integrates cleanly with the permissions system, adding a new "[URLs] View formatted URLs]" permission to each item.
• Distinguishes between a photo item and any other sort of item (but not on the permission level), link is only shown for photo items.
  As of 0.8.1:
• Separate BBCode/HTML blocks
• Also codes for clickable image thumbnails
• Shows Item IDs (which are apparently useful for embedded installations)
  As of 0.8.2:
• Complete site admin inteface to finetune all the options your little heart desires

Installation/Requirements

This module requires CoreAPI 6.10 and ModuleAPI 2.4 (latest nightly snapshot of G2).

As for installation, it's as straightforward as it can get: untar the attachment into your modules/ directory, install through 'Site Admin' interface.

Notice by G2 devs:
The latest version of this module is 0.9.2 and is attached to this first post. The latest version went through a code review and received a few new features.

Disclaimer: Since this tidbit of code is being released under the GPL it means that I am not responsible if it smokes your server or makes your dog scratch up your brand new furniture. I don't see how it could do either, but hey.

Devs: if you feel that this module is useful and want to get it in the G2 codebase, I'd be willing to work with you to satisfy the necessary requirements (unit tests? localisation? proper code formatting?). If not, that's okay too: I'm just releasing something I find useful into the wild.

Comments/Questions/Praise/Flames appreciated. Bharat's ten-page code reviews are not (just kidding, rip it apart).[/]

Yes, I see what you mean. I'm not sure how to use the URL Generator to create thumbnail image location URLs, is this possible?

The best idea would be to have a whole array (in the linguistic sense) of potential formats that could be activated/deactivated through the site admin interface. What do you guys think?

it might also be a good idea to have a small disclaimer for all links an anonymous user doesn't have access to. i.e. you as athe logged in user have permission to see the thumb/resize/fullsize, but an anonymous user may or may not see these things. and what good is a link in a bulletin board for if they can't see the hyperlinked item?

and a small feature request

If you could display the itemId, that would be great. People using a G2 integration in xaraya, wordpress etc. would like to include some G2 images/items in their website, i.e. in news or articles. If they could browse G2, click on your quick urls and get the itemId that way, that would be great!
(i.e. you could make the "show itemId" optional and turn it off by default.)

it's not a high priority request. i just thought it might be cool for integrated G2 and your module seems to be the right place to add something like that.

thanks a bunch, Kirill. I'm seeing forward to check the it out and give some recommendations in the embedding docs for this module

hello!

i'm running core 0.9.22 and had to do a little bit of modification to get this working. i added a new 'feature' and also i'm seeing a bug with this module in this core (i think!)

similar to your previous post, i had to change those lines to say:

        $this->setRequiredCoreApi(array(6, 0));
        $this->setRequiredModuleApi(array(0, 12));

then to get it working w/ url rewrite enabled, (i only messed w/ the 'BBCode Formatted Links' portion, but i'm sure the 'HTML Formatted Links' is very similar...) i had to change a few:

view=core:ShowItem
view=core:DownloadItem

to:

view=core.DownloadItem

lastly, i added a quick copy function for IE users (doesn't work in FF or more than likely any other browser... most argue that this takes advantage of an IE exploit more than a feature, heh) to push the data to the clipboard w/ one click instead of having to highlight the input text area. these links show up as:

[CLK]
[IMG]
[TMB]

to the right of the text box area. basically, open it up in IE and then click those 'links' and it'll push that info to your clipboard for you!

the bug i think i'm seeing is that it only produces links to the full-rez image in the event that there is a full rez and a sized image. no matter if you 'get item URLs' via the resized link or the full image link, you always get the full image id's. nor does the 'Misc.' section at the bottom 'The resized version ID that we're using is' work on either the sized or full image. i'm sure the issue is related - fix one, ya fix 'em both.

i wasn't sure how to fix that though...

at any rate - as i'm not sure i'm doing *any* of this correctly, i didn't modify your code so much as just add a few lines, heh! (except the core change of course. that had to be changed)

here it is, hope ya like it!

{*
 * $Revision: 1.20 $
 * If you want to customize this file, do not edit it directly since future upgrades
 * may overwrite it.  Instead, copy it into a new directory called "local" and edit that
 * version.  Gallery will look for that file first and use it if it exists.
 *}
<div class="gbBlock gcBackground1">
  <h2> 	{g->text text="Quick URLs"} </h2>
</div>


<div class="gbBlock"

{if $error.cantviewsource && $error.cantviewresizes && !$options.suppressSourceWarning}
<h2 class="giError">{g->text text="Warning! The permissions for this item are set so that unauthenticated users may not view it. If you are planning on linking to this item in a public forum or HTML page, the viewers will most likely not be able to access it."}</h2>
{/if}

{if $error.cantviewsource && !$error.cantviewresizes && !$options.suppressResizedWarning}
<h2 class="giError">{g->text text="Warning! The permissions for this item are set so that unauthenticated users may not view the full sized version, but the resized version is available. Links to the resized version are being used, this may not be what you want."}</h2>
{/if}

<p class="gbDescription">
	{g->text text="Through this page you can quickly get formatted URLs for this image."}
	  <br/>
	{g->text text="These can be used to post the image on forums and HTML pages by copying the code in the boxes below and pasting it into your application/browser."}
</p>

</div>

{if $options.HTMLlink || $options.HTMLinline || $options.HTMLthumbnail}
<div class="gbBlock">
<h2>{g->text text="HTML Formatted Links"}</h2>

{if $options.HTMLlink}
<p class="gbDescription">
	{g->text text="Link to the page of the image in HTML:"}
	<br />
	<input name="forum" type="text" readonly="true" size="85" value="&a href=&{g->url arg1="view=core:ShowItem" arg2="itemId=`$ItemGetURLsItem.id`"}&&click for image&/a&">
</p>
{/if}

{if $error.cantviewsource && !$error.cantviewresizes && $options.HTMLinline}
<p class="gbDescription">
	{g->text text="Show image directly in HTML (resized version will be shown):"}
	<br />
	<input name="forum" type="text" readonly="true" size="85" value="&img src=&{g->url arg1="view=core:DownloadItem" arg2="itemId=`$ItemGetURLsItem.resizeid`"}&&">
</p>

{else}
	{if $options.HTMLinline}
<p class="gbDescription">
	{g->text text="Show image directly in HTML:"}
	<br />
	<input name="forum" type="text" readonly="true" size="85" value="&img src=&{g->url arg1="view=core:DownloadItem" arg2="itemId=`$ItemGetURLsItem.id`"}&&">
</p>
	{/if}
{/if}

{if $options.HTMLthumbnail}
<p class="gbDescription">
	{g->text text="Show a clickable thumbnail to the bigger image in HTML:"}
	<br />
	<input name="forum" type="text" readonly="true" size="85" value="&a href=&{g->url arg1="view=core:ShowItem" arg2="itemId=`$ItemGetURLsItem.id`"}&&&img src=&{g->url arg1="view=core:DownloadItem" arg2="itemId=`$ItemGetURLsItem.thumbid`"}&&&/a&">
</p>
{/if}
</div>
{/if}

{if $options.BBClink || $options.BBCinline || $options.BBCthumbnail}
<div class="gbBlock">
	<h2>{g->text text="BBCode Formatted Links"}</h2>

{if $options.BBClink}
	<p class="gbDescription">
		{g->text text="Link to the page of the image in BBCode:"}
		<br />
		<input name="forum" type="text" readonly="true" size="85" value="[url={g->url arg1="view=core:ShowItem" arg2="itemId=`$ItemGetURLsItem.id`"}]click for image[/url]">
	  <input name="forum2" type="text" readonly="true" size="85" value="[url={g->url arg1="view=core.DownloadItem" arg2="itemId=`$ItemGetURLsItem.id`"}]click for image[/url]">
	  <a onclick="javascript:clipboardData.setData('Text','[url={g->url arg1="view=core.DownloadItem" arg2="itemId=`$ItemGetURLsItem.id`"}]click for image[/url]');window.status = '[CLK]{$ItemGetURLsItem.id}[/CLK] copied to your clipboard for forum posting!';" href>[CLK]</a> 
	</p>
{/if}

{if $error.cantviewsource && !$error.cantviewresizes && $options.BBCinline}
	<p class="gbDescription">
		{g->text text="Show image directly in BBCode (resized version will be shown):"}
		<br />
		<input name="forum" type="text" readonly="true" size="85" value="[img]{g->url arg1="view=core:DownloadItem" arg2="itemId=`$ItemGetURLsItem.resizeid`"}[/img]">
	</p>
{else}
	{if $options.BBCinline}
	<p class="gbDescription">
		{g->text text="Show image directly in BBCode:"}
		<br />
		<input name="forum" type="text" readonly="true" size="85" value="[img]{g->url arg1="view=core:DownloadItem" arg2="itemId=`$ItemGetURLsItem.id`"}[/img]">
	  <input name="forum" type="text" readonly="true" size="85" value="[img]{g->url arg1="view=core.DownloadItem" arg2="itemId=`$ItemGetURLsItem.id`"}[/img]">
	  <a onclick="javascript:clipboardData.setData('Text','[IMG]{g->url arg1="view=core.DownloadItem" arg2="itemId=`$ItemGetURLsItem.id`"}[/IMG]');window.status = '[IMG]{$ItemGetURLsItem.id}[/IMG] copied to your clipboard for forum posting!';" href>[IMG]</a> 
	</p>
	{/if}
{/if}

{if $options.BBCthumbnail}
	<p class="gbDescription">
		{g->text text="Show a clickable thumbnail to the bigger image in BBCode:"}
		<br />
		<input name="forum" type="text" readonly="true" size="85" value="[url={g->url arg1="view=core:ShowItem" arg2="itemId=`$ItemGetURLsItem.id`"}][img]{g->url arg1="view=core:DownloadItem" arg2="itemId=`$ItemGetURLsItem.thumbid`"}[/img][/url]">
    <input name="forum" type="text" readonly="true" size="85" value="[url={g->url arg1="view=core.ShowItem" arg2="itemId=`$ItemGetURLsItem.id`"}][img]{g->url arg1="view=core.DownloadItem" arg2="itemId=`$ItemGetURLsItem.thumbid`"}[/img][/url]">
	  <a onclick="javascript:clipboardData.setData('Text','[url={g->url arg1="view=core.ShowItem" arg2="itemId=`$ItemGetURLsItem.id`"}][img]{g->url arg1="view=core.DownloadItem" arg2="itemId=`$ItemGetURLsItem.thumbid`"}[/img][/url]');window.status = '[TMB]{$ItemGetURLsItem.thumbid}[/TMB] copied to your clipboard for forum posting!';" href>[TMB]</a>
	</p>
{/if}


</div>
{/if}

{if $options.MiscItemId || $options.MiscThumbnailId || $options.MiscResizeId}
<div class="gbBlock">
	<h2>{g->text text="Misc."}</h2>
	
{if $options.MiscItemId}
	<p class="gbDescription">{g->text text="The Gallery ID for this image is "} {$ItemGetURLsItem.id}.</p>
{/if}

{if $ItemGetURLsItem.resizeid && $options.MiscResizeId}
	<p class="gbDescription">{g->text text="The resized  version ID that we're using is "} {$ItemGetURLsItem.resizeid}.</p>
{/if}

{if $options.MiscThumbnailId}
	<p class="gbDescription">{g->text text="The thumbnail ID for this image is "} {$ItemGetURLsItem.thumbid}.</p>
{/if}
</div>
{/if}

whodah i been playing around with this for the past few hours and now mine is producing links to both the full and resized image. I have also made a few changes and have added an other option for how the links are made for the clickable thumbnails and the click here links. As admin you can have them eather go to the gallery2 page that the image is on, or have it just go to the image

i got the BB code part done right now i am edting the html part and adding your IE click thing to the html part

its also edited to work with the 2005-6-13 nightly build

heya!

looks sweet!! thanks!

i'm noticing one bug on mine:
for the:
Link to the page of the image in HTML:

the greater than and less than and quotes are showing up as & only. almost like the rest of the html entity got truncated off (in ItemGetURLs.tpl)

for instance, out of the box, for the first one, i was getting:

&a href=&http://www.cvreefers.org/v/CVR_members/whodah/whodah_zoanthids/whodah_zo_001-006/IMG_3570.jpg.html&&click for image&/a& 

and after fixing the html entities, now i get:

<a href="http://www.cvreefers.org/v/CVR_members/whodah/whodah_zoanthids/whodah_zo_001-006/IMG_3570.jpg.html">click for image</a>

are you seeing that too?

Very cool! How about adding an option to set the text-alignment of the image? Something like none, left, right. This way it can be pasted into a blog without any problems.

i'll have a fix for the broken html entities (& vs. < and > and ") here in a short bit.

i'm also gonna re-arrange the order a little from 'smallest to largest'.

i.e.
click text
thumbnail
sized
full size

this was requested by a user on my site and seems more intuitive then it's current order.

fix should be up w/in a couple hours.

thanks whodah for fixing the html tags i messed up some how, I did not get a chance to go through them all last night after work

frederik.kunz as to your text aliment, i am not shur how to go about that maybe the original writer or someone eals can add that in

Lfrank on your Forbidden thing i am not shure why you getting that, have you tryed unchecking the " Show Clickable/Link image in gallery2, If left unchecked it will just link to the image " option.

Hi,

probalbly found a reason for the "Forbidden" Issue.

Edited 13:30
looking in yesterdays template, I find a mix-up of "core.action" and "core:action". Strange only the effect described below.

Regards,
Lutz

Old - long version:

Even having i.e. the BB Code
[u=http://localmail.dynip.com/GALLERY2/d/54850-1/xxxx.jpg][ig]http://localmail.dynip.com/GALLERY2/d/54851-2/yyyy.jpg[/ig][/u]
(which displays the thumb perfect)
the HTML-Code is
href="http://localmail.dynip.com/GALLERY2/d/54850-1/xxxx.jpg" img src="http://localmail.dynip.com/GALLERY2/main.php?g2_view=core%3ADownloadItem&g2_itemId=yyyy"(removed the url, < and >)

Again the Thumb is displayed - but not the full image.
Having Short URL activated, I saw the thumb using still the full URL (http://localmail.dynip.com/GALLERY2/main.php?g2_view=core%3ADownloadItem&g2_itemId=xxxx) the full image using a short URL (http://localmail.dynip.com/GALLERY2/d/54850-1/yyyy.jpg).
Changing the URL of the full sized image to a full URL solved the issue.

I've just tested to disable the URL rewrite's for show and download on my system and got a workaround after changing the "Core.Download" to "Core%3ADownload" in the URL for the full sized image !!

Pewh... strange

Best regards,
Lutz

heya!

since we're making this a better module... i just noticed something else that's 'broken' w/ it...

if an image is so small that there is no resized image, it still attempts to create/report the resized links. but of course they are broken.

it'd be nifty to not report the 'resized' links if a resized image does not exist.

I have trouble with the BBCode shortcuts, neither the images or thumbnails work for me... maybe that's because the boards are too stupid to realise that the linked item IS an image even though there's no ".gif" or ".jpg" attached to the link?

Thanks. Issue solved now. I missed the moment mod_rewrite was enabled on the server.

EDIT: Figured out why flushing all caches and optimizing the database didn't help... I had to have Gallery rebuild the resized pics and thumbnails.

I just put a note of it here for the case another dummy like me comes across this issue :lol:

someone needs to update the module, it shouldn't be that hard. maybe just change the required api stuff in module.inc.

I've installed this module and though it generates the URL's just fine, they're not the shorter URL's that I expected to see as I have the re-write module active.

Did I miss something? :-?

use this template file for mod_rewrite to work ...

the earlier file had core:ShowItem links instead of the core.ShowItems

i'd try it, just change the 2 lines.

Nice, this worked, thanks! :D

Hi, here you go...
I'm dumb in PHP, if not I can help to add that in. :P

Anthony.

I've updated the geturls some, including:
1. it now does the correct permissions when viewing the page in guest preview mode
2. For all of us integrated cms users I have added the displaying of the direct url for the image or thumbnail without the html or bbcode around it.
3. I've added callback functionality

The code needs some refactoring but it's functional. I incremented the version to 0.8.4. I hope i'm not stepping on anyone's toes here but just wanted to submit what worked for me.

I have an app where I was looping through all the album children in the template and couldn't figure out how to get the thumbid for a child. So using the code from geturls I copied it into callback.inc and created a callback function so you can get the thumbid of the itemid you send it. There may be a better way but I couldn't find it.

Steve,

your 0.8.4 version works fine with KTHXBYE - HOWEVER i have one question/request ...

under "Link to the page of the image in BBCode:"
there should be 2 options....
1. Full sized image
2. <640x640> the .html page resized image.

since the thumbnail is too small, and the Full sized image in many cases it too large ... the end user should be able to choose from a realistic size image?

just my $0.02 .. ...
and Thanks for the working version - this is GREAT MOD!