The Arcive of Official vBulletin Modifications Site.

[AJAX] vBShout v2 on your vBadvanced CMPS v2! · **Released**: 10-03-2005

This is not essentially my hack, it's a group effort originating in the vBadvanced forums.

The following instructions will allow you to add vBShout v2.0 by Zero Tolerance as a fully collapsible module to your vBadvanced CMPS homepage v2.0.0, and remove it from your Forum Home [if you want]. Note, you must have both the vBShout product and CMPS installed with vBulletin 3.5.0 - it may work with Betas, but I really don't know.

This is a group effort from a few guys over at the vBadvanced forums, which includes Scotty2k and vbusers11 - I take no credit for this, I just spotted a problem with how the vBa forums was parsing postbits there. Plus the integration wasn't getting much attention over there and it would be a shame for users of vBShout and vBadvanced to miss out on this.

1) Create a new template based module called 'Shoutbox' in CMPS [ACP > vBa CMPS > Add Module > Template].

2) In 'Column', choose 'Center Column'.

3) Set 'Active' and 'Update All Pages' to Yes [assuming you want it to be active, and update all pages].

4 a) TO ADD AS A CENTRE MODULE - IF YOU DO THIS DO NOT FOLLOW STEPS B OR C!
In 'Template Content', paste the following code [this relies on you running your CMPS & vB in the same folder]. This will add a template to the selected Style called 'adv_portal_vbshout'.

Code:

<td class="alt1" align="left" width="100%">
	<form action="vbshout.php?{$session['sessionurl']}" method="post" name="vbshoutform" onsubmit="return postShout(this)">
		<input type='hidden' name='do' value='shout' />
		<input type='hidden' name='color' />
		<input type='hidden' name='fontFamily' />
		<input type='hidden' name='fontWeight' />
		<input type='hidden' name='textDecoration' />
		<input type='hidden' name='fontStyle' />

	<if condition="!$vboptions[shout_editor_position]">
		<if condition="$bbuserinfo[userid] > 0">
			<table width='100%' border='0' cellpadding='0' cellspacing='0'>
				<tr>
					<td width='100%'>
						<input type="text" name="shout" style="width: 90%" class="bginput" />
						</td>
						<td style='white-space:nowrap' width='1%'>
							<input type="submit" value="Shout" class="button" />
							<if condition="$vboptions[shout_extra_options]">
							<input type='button' class='button' value='Clear' onclick='sb_Clear()' />
							</if>
						</td>
					</tr>
					</table>
					<div style="height: 2px"></div>
					</if>
				</if>
					<div id="vbshout" style="overflow:auto;height:{$vboptions['shout_box_height']}px;width:100%;">
						Loading...
					</div>
				<if condition="$vboptions[shout_editor_position]">
					<if condition="$bbuserinfo[userid] > 0">
					<div style="height: 2px"></div>
					<table width='100%' border='0' cellpadding='0' cellspacing='0'>
					<tr>
						<td width='100%'>
							<input type="text" name="shout" style="width: 90%" class="bginput" />
						</td>
						<td style='white-space:nowrap' width='1%'>
							<input type="submit" value="Shout" class="button" />
							<if condition="$vboptions[shout_extra_options]">
							<input type='button' class='button' value='Clear' onclick='sb_Clear()' />													
							</if>
						</td>
					</tr>
					</table>
					</if>
				</if>
				</form>
				</td>

<script type='text/javascript'>
<!--

postingShout = false

function requestShouts()
{
	if (!postingShout)
	{
		ShoutRequest = new vB_AJAX_Handler(true)
		ShoutRequest.onreadystatechange(showShouts)
		ShoutRequest.send('vbshout.php', 'nocache=' + (5 * Math.random() * 1.33) )
	}
}

function showShouts()
{
	if (ShoutRequest)
	{
		if (ShoutRequest.handler.readyState == 4 && ShoutRequest.handler.status == 200 && ShoutRequest.handler.responseText)
		{
			Shouts           = fetch_object('vbshout')
			Shouts.innerHTML = '<table cellpadding="1" cellspacing="3" border="0" width="95%" align="left">' + ShoutRequest.handler.responseText + '</table>'
			setTimeout('requestShouts()', 10000)
			<if condition="$vboptions[shout_messages_order]">
			document.getElementById('vbshout').scrollTop = 99999;
			</if>
		}
	}
}

function sb_CollectHV(sbForm)
{
	rString = ''
	inputObjs = sbForm.getElementsByTagName('input')
	for (i = 0; i < inputObjs.length; i++)
	{
		if (inputObjs[i].type == 'hidden' && inputObjs[i].value != '')
		{
			rString += '&' + inputObjs[i].name + '=' + PHP.urlencode(inputObjs[i].value)
		}
	}

	return rString
}

function postShout(formObj)
{
	doShout = new vB_AJAX_Handler(true)
	doShout.onreadystatechange(postedShout)

	if (postingShout)
	{
		alert('Posting in progress..')
		return false
	}

	Shout = formObj.shout.value

	if (Shout.replace(/ /g, '') == '')
	{
		alert('You must enter a shout!')
		return false
	}

	doShout.send('vbshout.php', 'do=shout&shout=' + PHP.urlencode(Shout) + sb_CollectHV(document.forms['vbshoutform']))
	sb_Clear()
	postingShout = true

	return false
}

function postedShout()
{
	if (doShout.handler.readyState == 4 && doShout.handler.status == 200)
	{
		postingShout = false
		requestShouts()
	}
}

function sb_Input_SC(sProperty, setting)
{
	eval('document.forms["vbshoutform"].shout.style.' + sProperty + ' = "' + setting + '"')
	eval('document.forms["vbshoutform"].' + sProperty + '.value = "' + setting + '"')
}

function getSelectionValue(eSelector)
{
	return eSelector.options[eSelector.options.selectedIndex].value == 'Default' ? '' : eSelector.options[eSelector.options.selectedIndex].value
}

function sb_PropChange(eSelector, sProperty)
{
	sb_Input_SC(sProperty, getSelectionValue(eSelector))
}

function sb_PropChange_Button_Value(sProperty)
{
	trueValue = ''
	switch (sProperty)
	{
		case 'fontWeight':
		falseValue = 'bold'
		break;

		case 'textDecoration':
		falseValue = 'underline'
		break;

		case 'fontStyle':
		falseValue = 'italic'
		break;
	}

	return (eval('document.forms["vbshoutform"].' + sProperty + '.value'))? trueValue : falseValue
}

function sb_PropChange_Button(cButton, sProperty)
{
	if (cButton.value.match(/\*/))
	{
		cButton.value = cButton.value.replace(/\s+\*/, '')
	}
	else
	{
		cButton.value = cButton.value + ' *'
	}

	sb_Input_SC(sProperty, sb_PropChange_Button_Value(sProperty))
}

function sb_Smilie(code)
{
	document.forms["vbshoutform"].shout.value += ' ' + code
	return false
}

function sb_Clear()
{
	document.forms["vbshoutform"].shout.value = ''
	return true;
}

function sb_Smilies(cButton)
{
	if (cButton.value.match(/\*/))
	{
		cButton.value = cButton.value.replace(/\s+\*/, '')
	}
	else
	{
		cButton.value = cButton.value + ' *'
	}
	
	document.getElementById('shout_emo').style.display   = (document.getElementById('shout_emo').style.display == 'none')? '' : 'none'
}

requestShouts()

-->
</script>

4 b) TO ADD AS A SIDE MODULE - ONLY FOLLOW THIS STEP IF YOU DID NOT PERFORM STEP A.
In 'Template Content', paste the following code [this relies on you running your CMPS & vB in the same folder]. This will add a template to the selected Style called 'adv_portal_vbshout'.

Code:

<td class="alt1" align="left">
	<form action="vbshout.php?{$session['sessionurl']}" method="post" name="vbshoutform" onsubmit="return postShout(this)">
		<input type='hidden' name='do' value='shout' />
		<input type='hidden' name='color' />
		<input type='hidden' name='fontFamily' />
		<input type='hidden' name='fontWeight' />
		<input type='hidden' name='textDecoration' />
		<input type='hidden' name='fontStyle' />

	<if condition="!$vboptions[shout_editor_position]">
		<if condition="$bbuserinfo[userid] > 0">
			<table border='0' cellpadding='0' cellspacing='0'>
				<tr>
					<td>
						<input type="text" name="shout" style="width: 100%" class="bginput" />
						</td>
						<td style='white-space:nowrap' width='1%'>
							<input type="submit" value="Shout" class="button" />
							</td>
					</tr>
					</table>
					<div style="height: 2px"></div>
					</if>
				</if>
					<div id="vbshout">
						Loading...
					</div>
				<if condition="$vboptions[shout_editor_position]">
					<if condition="$bbuserinfo[userid] > 0">
					<div style="height: 2px"></div>
					<table border='0' cellpadding='0' cellspacing='0'>
					<tr>
						<td>
							<input type="text" name="shout" style="width: 90%" class="bginput" />
						</td>
						<td style='white-space:nowrap' width='1%'>
							<input type="submit" value="Shout" class="button" />
							<if condition="$vboptions[shout_extra_options]">
							<input type='button' class='button' value='Clear' onclick='sb_Clear()' />													
							</if>
						</td>
					</tr>
					</table>
					</if>
				</if>
				</form>
				</td>

<script type='text/javascript'>
<!--

postingShout = false

function requestShouts()
{
	if (!postingShout)
	{
		ShoutRequest = new vB_AJAX_Handler(true)
		ShoutRequest.onreadystatechange(showShouts)
		ShoutRequest.send('vbshout.php', 'nocache=' + (5 * Math.random() * 1.33) )
	}
}

function showShouts()
{
	if (ShoutRequest)
	{
		if (ShoutRequest.handler.readyState == 4 && ShoutRequest.handler.status == 200 && ShoutRequest.handler.responseText)
		{
			Shouts           = fetch_object('vbshout')
			Shouts.innerHTML = '<table cellpadding="1" cellspacing="3" border="0" width="95%" align="left">' + ShoutRequest.handler.responseText + '</table>'
			setTimeout('requestShouts()', 10000)
			<if condition="$vboptions[shout_messages_order]">
			document.getElementById('vbshout').scrollTop = 99999;
			</if>
		}
	}
}

function sb_CollectHV(sbForm)
{
	rString = ''
	inputObjs = sbForm.getElementsByTagName('input')
	for (i = 0; i < inputObjs.length; i++)
	{
		if (inputObjs[i].type == 'hidden' && inputObjs[i].value != '')
		{
			rString += '&' + inputObjs[i].name + '=' + PHP.urlencode(inputObjs[i].value)
		}
	}

	return rString
}

function postShout(formObj)
{
	doShout = new vB_AJAX_Handler(true)
	doShout.onreadystatechange(postedShout)

	if (postingShout)
	{
		alert('Posting in progress..')
		return false
	}

	Shout = formObj.shout.value

	if (Shout.replace(/ /g, '') == '')
	{
		alert('You must enter a shout!')
		return false
	}

	doShout.send('vbshout.php', 'do=shout&shout=' + PHP.urlencode(Shout) + sb_CollectHV(document.forms['vbshoutform']))
	sb_Clear()
	postingShout = true

	return false
}

function postedShout()
{
	if (doShout.handler.readyState == 4 && doShout.handler.status == 200)
	{
		postingShout = false
		requestShouts()
	}
}

function sb_Input_SC(sProperty, setting)
{
	eval('document.forms["vbshoutform"].shout.style.' + sProperty + ' = "' + setting + '"')
	eval('document.forms["vbshoutform"].' + sProperty + '.value = "' + setting + '"')
}

function getSelectionValue(eSelector)
{
	return eSelector.options[eSelector.options.selectedIndex].value == 'Default' ? '' : eSelector.options[eSelector.options.selectedIndex].value
}

function sb_PropChange(eSelector, sProperty)
{
	sb_Input_SC(sProperty, getSelectionValue(eSelector))
}

function sb_PropChange_Button_Value(sProperty)
{
	trueValue = ''
	switch (sProperty)
	{
		case 'fontWeight':
		falseValue = 'bold'
		break;

		case 'textDecoration':
		falseValue = 'underline'
		break;

		case 'fontStyle':
		falseValue = 'italic'
		break;
	}

	return (eval('document.forms["vbshoutform"].' + sProperty + '.value'))? trueValue : falseValue
}

function sb_PropChange_Button(cButton, sProperty)
{
	if (cButton.value.match(/\*/))
	{
		cButton.value = cButton.value.replace(/\s+\*/, '')
	}
	else
	{
		cButton.value = cButton.value + ' *'
	}

	sb_Input_SC(sProperty, sb_PropChange_Button_Value(sProperty))
}

function sb_Smilie(code)
{
	document.forms["vbshoutform"].shout.value += ' ' + code
	return false
}

function sb_Clear()
{
	document.forms["vbshoutform"].shout.value = ''
	return true;
}

function sb_Smilies(cButton)
{
	if (cButton.value.match(/\*/))
	{
		cButton.value = cButton.value.replace(/\s+\*/, '')
	}
	else
	{
		cButton.value = cButton.value + ' *'
	}
	
	document.getElementById('shout_emo').style.display   = (document.getElementById('shout_emo').style.display == 'none')? '' : 'none'
}

requestShouts()

-->
</script>

4 c) ONLY PERFORM THIS STEP IF YOU DID NOT PERFORM STEP A!
Edit your 'forumhome_vbshout_shout' template [ACP > Styles & Templates > Style Manager > YOUR DEFAULT STYLE > forumhome_vbshout_shout], and replace it's contents with the following.

Code:

<tr>
				<td align="left" valign="top">
<span class="smallfont">
<if condition="!$Shout[s_me]">
						<if condition="$Shout[s_by]">
							<a href='member.php?{$session['sessionurl_q']}u={$Shout['s_by']}'>
						</if>{$Shout['username']}<if condition="$Shout[s_by]"></a></if>:
					</if>
									<if condition="!$Shout[s_me]">
						{$Shout['s_shout']}
					<else />
						<span class='highlight'>
							*{$Shout['username']} {$Shout['s_shout']}*
						</span>
					</if>
</span>
				</td>
			</tr>

5) In the 'Module Shell Template Options' section when adding a template, add the following URL in 'Module Link'.

http://www.mysite.com/vbshout.php?do=archive

The above, again assumes you have CMPS & vBa running in the same folder. Replace www.mysite.com with the address of your website.

If your CMPS & vB are not installed in the same folder, you will need to replace all instances of 'vbshout.php' in the template and in 'Module Link' with the path to where you have vBShout installed in relation to your CMPS. For example if you have CMPS installed in the root folder, and vBshout within a folder called 'forum' you would need to replace all instances of 'vbshout.php' with '/forum/vbshout.php'.

Removing vBShout from your Forum Home - IF YOU FOLLOWED STEP 4 b) YOU HAVE TO DO STEP 5 - YOUR VBSHOUT WILL NOT RENDER CORRECTLY ON YOUR FORUM HOME! IF YOU HAVE YOUR SHOUTBOX AS A CENTRE MODULE ON THE CMPS, AND WANT TO ALSO HAVE IT RUNNING ON THE FORUM HOME, DO NOT PERFORM THIS STEP!

6) In your ACP go to [ACP > Plugin System > Plugin Manager] - find on that page 'vBShout [Template Alteration]' and uncheck the box which will deactivate it.

That's all there is to it folks, a very simple fix to the problem.

Wachtmeister · #22 10-04-2005, 02:54 PM

Quote:

Originally Posted by Prodimysterio

Everything works fine with the exception of one problem. Within the shoutbox itself, if you click on someone's name, it tries to take you to:

[high]* Prodimysteriomber.php
[/high]

instead of (in my case)

/forums/member.php

Can someone assist in resolving this issue?

Oups, same problem here. And yes, i have replaced all vbshout.php to /forum/vbshout.php. It just links to member.php instead of <path to forum>/member.php.

Regards

Prodimysterio · #23 10-04-2005, 02:56 PM

Also, can someone post how to remove the time that is in front of the usernames from within the shoutbox module? It was posted in the other thread as to how to remove it from forumhome, but that code is not the same in the CMPS module.

Thanks!

Romeos Tune · #24 10-04-2005, 02:58 PM

What do you have for your module link?

Prodimysterio · #25 10-04-2005, 03:07 PM

Quote:

Originally Posted by Romeos Tune

What do you have for your module link?

http://www.myforums.com/forums/vbshout.php?do=archive

FleaBag · #26 10-04-2005, 03:26 PM

I'll post how to remove the time [which I now intend to do myself] from it later tonight. I'll also amend any .php references that need to be updated to work correctly. Will try to sort out a side module too, although I'm not promising anything.

Prodimysterio · #27 10-04-2005, 03:28 PM

Quote:

Originally Posted by FleaBag

I'll post how to remove the time [which I now intend to do myself] from it later tonight. I'll also amend any .php references that need to be updated to work correctly. Will try to sort out a side module too, although I'm not promising anything.

Thanks FleaBag, much appreciated.

:nervous:

michaelbenson · #28 10-04-2005, 03:38 PM

Thanks, the perfect addon!

Prodimysterio · #29 10-04-2005, 03:40 PM

Also, when my users are in the shoutbox, the following appears in "who's online"

Quote:

Unknown Location /forums/vbshout.php/

Can that be resolved as well?

FleaBag · #30 10-04-2005, 03:56 PM

Hmm the same problem is present with vBShout. I think that would need to be fixed as part of the hack itself; although I'll certainly take a look tonight.

JJR512 · #31 10-04-2005, 05:33 PM

I've installed it and in general it works fine. However, I am having one problem.

Actually it's the same problem I've had with the vBShout, which you can read about in that thread. In a nutshell, whenever someone was on my forums home page, if you looked at Who's Online it would say they were viewing the shoutbox. The link would be to the forums home page, though. I tested this myself, on myself, by going to the forums home page, refreshing, then going straight to Who's Online. Sure enough, there it says I'm viewing the shoutbox, with a link to the forums home page.

Now that I've installed this add-on, the problem has been expanded to my main cmps page, too. If I'm looking at that page, then jump to Who's Online, it says I'm looking at the shoutbox, with a link to my main cmps page.

I don't consider this to be a problem with this add-on, I think it's simply an effect of a problem/issue with the underlying vBShout hack. I've checked the hack's plugins to the Who's Online system, and compared to others, and both are fine. As far as I can tell, there's no problem with the plugins. I don't even know for sure that the problem is the hack itself; it could be something with vBulletin--I'm starting to think that if a page (like index.php) gets output from another page (like vbshout.php), then for some reason vBulletin considers vbshout.php to be the page the viewer is on.

Whatever the problem is, although I've documented and explained it, I have yet to get any help or suggestions. Maybe, FleaBag, you could have those people over at vBadvanced, who wrote this add-on, look into it, if they're familiar with the hack already?

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.09176 seconds Memory Usage 2,345KB Queries Executed 26 (?)
More Information
Template Usage: (1)SHOWTHREAD (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (1)ad_showthread_beforeqr (3)bbcode_code (4)bbcode_quote (1)footer (1)forumjump (1)forumrules (1)gobutton (1)header (1)headinclude (1)modsystem_post (1)navbar (6)navbar_link (120)option (1)pagenav (1)pagenav_curpage (4)pagenav_pagelink (1)pagenav_pagelinkrel (11)post_thanks_box (11)post_thanks_button (1)post_thanks_javascript (1)post_thanks_navbar_search (11)post_thanks_postbit_info (10)postbit (11)postbit_onlinestatus (11)postbit_wrapper (1)spacer_close (1)spacer_open (1)tagbit_wrapper Phrase Groups Available: global inlinemod postbit posting reputationlevel showthread	Included Files: ./showthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/functions_bigthree.php ./includes/class_postbit.php ./includes/class_bbcode.php ./includes/functions_reputation.php ./includes/functions_post_thanks.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete showthread_start showthread_getinfo forumjump showthread_post_start showthread_query_postids showthread_query bbcode_fetch_tags bbcode_create showthread_postbit_create postbit_factory postbit_display_start post_thanks_function_post_thanks_off_start post_thanks_function_post_thanks_off_end post_thanks_function_fetch_thanks_start post_thanks_function_fetch_thanks_end post_thanks_function_thanked_already_start post_thanks_function_thanked_already_end fetch_musername postbit_imicons bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete postbit_display_complete post_thanks_function_can_thank_this_post_start pagenav_page pagenav_complete tag_fetchbit_complete forumrules navbits navbits_complete showthread_complete
Messages:

The Arcive of Official vBulletin Modifications Site.

It is not a VB3 engine, just a parsed copy!