summaryrefslogtreecommitdiff
path: root/plugins/data.attachment.php
blob: 6cf0648982fb3c8dc51999cee16ed99b23354bbc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<?php
/**
 * @version  $Revision: 1.19 $
 * @package  liberty
 * @subpackage plugins_data
 */
// +----------------------------------------------------------------------+
// | Copyright (c) 2004, bitweaver.org
// +----------------------------------------------------------------------+
// | All Rights Reserved. See copyright.txt for details and a complete list of authors.
// | Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details
// |
// | For comments, please use phpdocu.sourceforge.net documentation standards!!!
// | -> see http://phpdocu.sourceforge.net/
// +----------------------------------------------------------------------+
// | Authors: drewslater <andrew@andrewslater.com>
// +----------------------------------------------------------------------+
// $Id: data.attachment.php,v 1.19 2007/05/20 01:31:17 laetzer Exp $

/**
 * definitions
 */
global $gBitSystem;

define( 'PLUGIN_GUID_DATAATTACHMENT', 'dataattachment' );
global $gLibertySystem;
$pluginParams = array (
	'tag'           => 'attachment',
	'auto_activate' => TRUE,
	'requires_pair' => FALSE,
	'load_function' => 'data_attachment',
	'title'         => 'Attachment',
	'help_page'     => 'DataPluginAttachment',
	'description'   => tra("Display attachment in content"),
	'help_function' => 'data_attachment_help',
	'syntax'        => '{attachment id= size= align= }',
	'path'          => LIBERTY_PKG_PATH.'plugins/data.attachment.php',
	'security'      => 'registered',
	'plugin_type'   => DATA_PLUGIN,
	'biticon'       => '{biticon iclass= "quicktag icon" ipackage=quicktags iname=attachment iexplain="Image"}',
	'taginsert'     => '{attachment id= align= size= description=}',
);
$gLibertySystem->registerPlugin( PLUGIN_GUID_DATAATTACHMENT, $pluginParams );
$gLibertySystem->registerDataTag( $pluginParams['tag'], PLUGIN_GUID_DATAATTACHMENT );


function data_attachment_help() {
	$help =
		'<table class="data help">'
			.'<tr>'
				.'<th>' . tra( "Key" ) . '</th>'
				.'<th>' . tra( "Type" ) . '</th>'
				.'<th>' . tra( "Comments" ) . '</th>'
			.'</tr>'
			.'<tr class="odd">'
				.'<td>id</td>'
				.'<td>' . tra( "numeric") . '<br />' . tra("(required)") . '</td>'
				.'<td>' . tra( "Id number of Attachment to display inline.") . '</td>'
			.'</tr>'
			.'<tr class="even">'
				.'<td>size</td>'
				.'<td>' . tra( "key-words") . '<br />' . tra("(optional)") . '</td>'
				.'<td>' . tra( "If the Attachment is an image, you can specify the size of the thumbnail displayed. Possible values are:") . ' <strong>avatar, small, medium, large, original</strong> '
				. tra( "(Default = " ) . '<strong>medium</strong>)</td>'
			.'</tr>'
			.'<tr class="odd">'
				.'<td>link</td>'
				.'<td>' . tra( "string") . '<br />' . tra("(optional)") . '</td>'
				.'<td>' . tra( "Allows you to specify a relative or absolute URL the image will link to if clicked. If set to false, no link is inserted.")
				. tra("(Default = ") . '<strong>'.tra( 'link to source image' ).'</strong>)</td>'
			.'</tr>'
			.'<tr class="even">
				<td>page_id</td>
				<td>'.tra( 'numeric (optional)' ).'</td>
				<td>'.tra( "To include any wiki page you can use it's page_id number." ).'</td>
			</tr>
			<tr class="odd">
				<td>content_id</td>
				<td>'.tra( 'numeric (optional)' ).'</td>
				<td>'.tra( 'To include any content from bitweaver insert the apprpropriate numeric content id. This can include blog posts, images, wiki texts...<br />
					Avaliable content can be viewed <a href="'.LIBERTY_PKG_URL.'list_content.php">here</a>' ).'</td>
			</tr>
			<tr class="even">
				<td>display</td>
				<td>'.tra( 'keyword (optional)' ).'</td>
				<td>'.tra( "If you are attaching a file and you only want to display the description and not the image that goes with it, use: display=desc" ).'</td>
			</tr>'
			.'<tr class="odd">'
				.'<td>'.tra( "styling" ).'</td>'
				.'<td>'.tra( "string").'<br />'.tra("(optional)").'</td>'
				.'<td>'.tra( "Multiple styling options available: padding, margin, background, border, text-align, color, font, font-size, font-weight, font-family, align. Please view CSS guidelines on what values these settings take.").'</td>'
			.'</tr>'
		.'</table>'
		. tra("Example: ") . "{ATTACHMENT id='13' size='small' text-align='center' link='http://www.google.com'}";
	return $help;
}

function data_attachment( $pData, $pParams ) { // NOTE: The original plugin had several parameters that have been dropped
	// at a minimum, return blank string (not empty) so we still replace the tag
	$ret = ' ';
	if( empty( $pParams['id'] ) ) {
		// The Manditory Parameter is missing. we are not gonna trow an error, and just return empty since
		// many sites use the old style required second "closing" empty tag
		return $ret;
	}

	$liba = new LibertyAttachable();
	if( !$att = $liba->getAttachment( $pParams['id'] ) ) {
		$ret = tra( "The attachment id given is not valid." );
		return $ret;
	}

	// insert source url if we need the original file
	if( !empty( $pParams['size'] ) && $pParams['size'] == 'original' ) {
		$thumburl = $att['source_url'];
	} elseif( !empty( $att['thumbnail_url'] )) {
		$thumburl = ( !empty( $pParams['size'] ) && !empty( $att['thumbnail_url'][$pParams['size']] ) ? $att['thumbnail_url'][$pParams['size']] : $att['thumbnail_url']['medium'] );
	}

	// check if we have a valid thumbnail
	if( !empty( $thumburl ) ) {
		$div = liberty_plugins_div_style( $pParams );

		// set up image first
		$ret = '<img'.
				' alt="'.  ( !empty( $div['description'] ) ? $div['description'] : tra( 'Image' ) ).'"'.
				' title="'.( !empty( $div['description'] ) ? $div['description'] : tra( 'Image' ) ).'"'.
				' src="'  .$thumburl.'"'.
			' />';

		$ret .= ( !empty( $att['file_details'] ) ? '<br />'.$att['file_details'] : '' );

		// link to page by page_id
		if( @BitBase::verifyId( $pParams['page_id'] ) ) {
			require_once( WIKI_PKG_PATH.'BitPage.php');
			$wp = new BitPage( $pParams['page_id'] );
			if( $wp->load() ) {
				$pParams['link'] = $wp->getDisplayUrl();
			}
		// link to any content by content_id
		} elseif( isset( $pParams['content_id'] ) && is_numeric( $pParams['content_id'] ) ) {
			if( $obj = LibertyBase::getLibertyObject( $pParams['content_id'] ) ) {
				$pParams['link'] = $obj->getDisplayUrl();
			}
		// link to page by page_name
		} elseif( isset( $pParams['page_name'] ) ) {
			require_once( WIKI_PKG_PATH.'BitPage.php');
			$wp = new BitPage();
			$pParams['link'] = $wp->getDisplayUrl( $pParams['page_name'] );
		}

		if( !empty( $div['description'] ) && !empty( $pParams['display'] ) && ( $pParams['display'] == 'desc' || $pParams['display'] == 'description' ) ) {
			$ret = ( !empty( $div['description'] )  ? $div['description'] : '' );
			$nodiv = TRUE;
		} else {
			$ret .= ( !empty( $div['description'] )  ? '<br />'.$div['description']  : '' );
		}

		// use specified link as href. insert default link to source only when 
		// source not already displayed
		if( !empty( $pParams['link'] ) && $pParams['link'] == 'false' ) {
		} elseif( !empty( $pParams['link'] ) ) {
			if(( strstr( $pParams['link'], $_SERVER["SERVER_NAME"] )) || (!strstr( $pParams['link'], '//' ))) {
				$class = '';
			} else {
				$class = 'class="external"';
			}

			$ret = '<a '.$class.' href="'.trim( $pParams['link'] ).'">'.$ret.'</a>';
		} elseif( empty( $pParams['size'] ) || $pParams['size'] != 'original' ) {
			if( !empty( $att['download_url'] ) ) {
				$ret = '<a href="'.trim( $att['download_url'] ).'">'.$ret.'</a>';
			} else {
				$ret = '<a href="'.trim( $att['source_url'] ).'">'.$ret.'</a>';
			}
		}

		// finally, wrap the output with a span instead of a div to avoid invalid markup if att placed inside paragraph or inline element
		if( empty( $nodiv ) ) {
			$ret =
				'<span class="'.( isset($div) && !empty( $div['class'] ) ? $div['class'] : "att-plugin" ).'" style="'.(isset($div) ? $div['style'] : '').'">'.
				$ret.'</span>';
		}
	} else {
		$ret = tra( "The attachment id given is not valid." );
	}

	return $ret;
}
?>