Paypal Donations for vBulletin 3.0.7

Due to real life I have ended support of this hack. Please see licensing information below.

Please read the troubleshooting tips below before asking for support.

********************************

Paypal Donations for vBulletin 3.0.7

Hack Provided and coded by )O( Cloudrunner )O( of The Noble Pagan.

Release version: 1.07
Release Date: 28 June 2005

ChangeLog:

Paypal Donations 1.08

• Simple file changes.
• fixed problem in template edits.

Paypal Donations 1.07

• Squashed an uninstaller bug that was plaguing many folks with a bad explode command.
• Attempted an adjustment in the graph image maker file pp_image.php
  • Two Templates require revert for this fix:
    • donations_goal_bits (required)
    • adv_portal_donate_goals (required only if you have installed the vBadvance CMPS Module)
• Fixed the graph bar color settings to show whether or not you installed the CMPS module.

Paypal Donations 1.06

• Fixed small bug that displayed all users as donors regardless of their actual donor status.
• Repaired typo in AdminCP

Paypal Donations 1.05

• Fixed phrasing that showed up as loads of '\r\n' on the on the pages.
• Added all donors page to system to show all donors
• Added functionality so that shy users can hide their donor status from public view
• Fixed a division by zero error that shows when a goal is assigned without a goal amount.

Paypal Donations 1.04

• Fixed bug with the AdminCP that did not allow the user avatars to be displayed when viewing all donors.
• Redid templates so that the currency sign changes automagickally to the chosen base currency.
• Fixed an error on the installer that placed a dupe entry preventing further installation progress.
• Redid installer for ease of updating the system when needed.

Paypal Donations 1.03

• Fixed bug where on installation the currency exchanges were not being populated properly.
• Changed user list on donor add in AdminCP to be sorted alphabetically
• Fixed Avatar display for custom avatars in the AdminCP
• Fixed short hand INSERTs in the installer. Should work with all versions of DB schemas now.

Special Thanks:
dsboyce8624
SLeeeper
And all of the Alpha Testers that helped out with this Hack!

I couldn't have done it without you.

What it does

Quite simply this hack provides you a way to receive donations from your website's users and provide them with the recognition deserving of a donating member of you community. It uses Paypal exclusively because of Paypal's "Instant Payment Notification" system.

The basics are this:

• Your users go to your donations page where you have certain levels of donations available via hyperlinked "buttons".
• These buttons take your user to paypal's secure payment processing system where they pay you your donation.
• Once payment has been received, paypal sends your server a notification containing certain information pertaining to that specific transaction.
• Your server then repeats this information to the verification server (which is hardcoded into the system so that *spoofing* is rendered virtually impossible) which first checks to see if the information was sent by it, then checks the validity of the information.
• If everything checks out, it then sends your server a response of "VERIFIED".
• When this hack see that word after running the script it inserts all the information into your database so that you can see what was donated, who donated it, and where.
• If the server returns a response of "INVALID" then this script drops the information into a separate table so that you can investigate the transaction further to detect fraud attempts.
  • It also does this on any suspicious entries after a few checks.
• Once payment is verified and information has been inserted into the tables, the system then adds a few toys and items for the user to be recognized as a donating user.
  • What you do with that recognition is up to you.

Features

• You as the admin have the ability to show as little or as much as you want about what happens with your donations.
• Your users will only see what you want them to see.
• You can show your donation goals to the public.
• Automatic updates EVERY time a user donates or retracts a donation.
• This can be run in "dummy" test mode using Paypal's Sandbox site for testing purposes before you go live with it.
• Your members who have donated are recognized for doing so in their profile and their postbit.
  • Your shy users have the ability to hide their donation status from public view in their profile options
• vBadvanced CMPS Module Integrated
• You can set Goals and have donations count for or against a specific goal
• Multiple Currencies are supported automatically and use TODAY's exchange rate to make the donation (vB Cron Enabled)
• Everything is controllable in the AdminCP
• User-side is 100% phrased
• System completely ignores any transaction not placed by it (i.e. Ebay transactions and other PayPal transactions are not included in your transaction history (cuts down on DB bloat)).
• Donate Button(s) PNG source provided (Image Credits go to SLeeeper, Thank you for the help!)
• You do NOT need to have paypal's IPN pointing at the system. The system tells Paypal WHERE to send the IPN transactions :-}

**Coming Soon**

• Postbit Awards for certain levels of donations that you decide on
• Donation / Donor Categories

Stuff you have to do

Files to upload: 34
Files to modify: 3
Templates to modify: 1 (required) / 2 (Optional)
Queries to run: (The install script does this for you, uninstallation is also provided as well)
Ease of install: easy, simply follow the instructions in the install script.
Time of install: ~5 minutes

***REMEMBER! Add your email address that Paypal has on file in Donations settings. This step is not an option, your payments, although they may be valid, will all be considered invalid if you do not do this! Sign up for Paypal's Premiere Account (Business), and setup IPN.

Paypal Registration

You will need to register with Paypal for a premiere account if you have not already, if you have, but your account is probably a personal account, you will need to upgrade the account to a premiere account. Assuming that you have a premiere account and have been verified, you then go into your profile at http://www.paypal.com and the select Instant Payment Notification. There will be a checkbox that you must check, you do NOT have to point to the script at Paypal, if you choose not to do this, then you will need to make sure that your Notification URL is put in the settings or this script will NOT WORK!

On most systems it will be either:

http://www.yourdomain.com/ppverify.php

or

http://www.yourdomain.com/forum/ppverify.php

That's all there is to setting up Paypal to work with your site!

Install

Upload all the files in the archive into their provided directories

Run the provided install file, setup your settings, after installation, DELETE THE FILE!

This will usually be:

http://www.yourdomain.com/forum/admi...ns_install.php

or

http://www.yourdomain.com/admincp/donations_install.php

How To Use The System

To begin with, you simply upload all the files into their respective directories (keeping the structure in the archive).

After you upload the files, point your browser to the installation file: donations_install.php and run the installer all the way through, remembering to save your settings at the end (you MUST put in your paypal email, and the path to donate.php, and the path to ppverify.php). Remember, if you have the system set in test mode, you will not be able to process LIVE transactions. If you are going live immediately, then change this setting to no!
After you install, simply delete the donation_install folder and all files within it, and the install file.

Now you are ready to play. The system is 100% phrased on the user viewable side, so you will need to edit some of the phrases to better suit your site, specifically the phrases titled:

your_donations_are_appreciated
all_donations_go_towards_furthering_goals
donation_used_to_further_mission

are the ones that I recommend redoing to suit your site.

After editing the phrases, next comes adding your donation buttons and goals.

Always add your goals first as the buttons can be attached to a specific goal so that the user gets credit for donating towards a specific goal (you can of course add a button that does not attach to a goal for a general coffer fund type of deal, but goals are the preferred method).

After adding a goal, you can then add a button to the site.

The settings for the buttons are self-explanatory for the most part, the only required input from you is the title, and the description of the button. Everything else will work fine without input.

The system defaults to use the USD currency. If you change this currency in the Donations settings, then to get the correct exchange pricing, you need to run the CRON file to update your Exchange Rates table.

To do this simply log into your AdminCP and then do the following:

1. Scroll down your navigation bar on the left and find the Scheduled tasks navigation group, open that up and click on "Scheduled Task Manager".
2. Find the CRON named "Donations Currency Exchange Quotes"
3. To the right of that you will find a button named "Run Now"
4. Click that button and wait until the system says Done.

Once the system has reloaded the exchange rates using your new currency you are ready to go and start collecting donations.

From there, it's all fairly intuitive. The biggest thing to remember is that to use this hack you MUST have a paypal Business or Premiere account, and have turned IPN on in your Paypal profile. If you run into troubles with a transaction, make sure that you are not trying to verify a sandbox transaction with the live Paypal server and vice versa (the test setting). Secondly, this system will notify you of suspect transactions that Paypal refuses to validate. If you get an email stating that a transaction was invalid, it would suit you to investigate it to find out where the transaction came from and why it failed verification. If all is kosher you can add the donor to the AdminCP so that they get credit for the donation.

To assist in this you can edit an invalid transaction to show as valid if the transaction turns out to be kosher. The steps to this are as follows:

1. Make sure transaction is valid
2. Edit invalid transaction to show as valid
3. Edit goal and add that transaction amount to the total
4. Edit / Add donor (user) to the DB to give credit

This will get the transaction into your database properly and give credit everywhere it is needed for the system to read it properly.

After Install

You will need to add a link somewhere in your navigation system for vBulletin pointing your users to the donations page (if you installed the vBadvanced Module then you have a link on the home page, but you might want to add one in the nav bar as well), as well as setting up your paypal account to give IPN responses to you, you can do this in your Paypal Profile under Instant Payment Notification.

To play in PayPal's Sandbox you will need to be registered with their developer network and setup a few sandbox accounts to play with the sandbox properly. I have throughly tested the sandbox functionality, and it is working until they decide to change coding standards again.

Troubleshooting tips and procedures

Due to the multitude of possible break-points between Paypal and this script I must request that the following be followed before reequesting support on this system from this point forward:

1. Do some basic troubleshooting on your own first and see if you can find where the break happened. You might be able to fix it from that.
2. Check to see that you are not sending test transactions to the live Paypal Server (check your testing setting in AdminCP)
3. Verify that your custom variable is output as

   <input type="hidden" name="custom" value="donation:*userid*:*goalid*">

4. Make sure that you COMPLETED the install 100% (if you did not make it to the settings page at the end of the installation, then you did not complete the installation)
5. Make sure that you have done the two required file edits (you can go back into the installer to verify this)
6. If you had a donation made, but have not yet received notification at the script side of the house, then the transaction most likely went into the invalid transactions tables, check there if it is there, and you have verified the top three things above post here for support on this. There is a time lag in the invalid transaction notifications. If you receive an invalid transaction you will receive notification by email to the webmaster address in your vB settings. I need the following information in this circumstance:
   1. A post of the contents of the invalid table with identifiable information removed (ie. transaction id, addresses, phone numbers, IP addresses etc.)
   2. The address to your donate.php file
   3. Whether your system is in test mode or live mode
7. For basic support problems, then I will need the address to your donate.php so that I can verify that your system is kicking out the proper information to send to paypal
8. Above all else, please try to be as specific as possible, "The system broke..." doesn't do me any good to assist in giving you support, "The system broke at line 58 with the following error" is much better, and I am much more willing to support your problem with this symptom.

Lastly, if you have modified the base files in any way, I will NOT give support to this. The files are set in the way that they need to be to run under 90% of server installations. Any other installations that require files to be merged, etc., sorry but you are on yer own in that situation.

FYI: The Paypal Notification is completely seperate from the user being sent back to your site. Thus the reason that the ppverify.php file is NOT a function of donate.php.

How To Get vBadvanced CMPS v1 Module to work with vBadvance CMPS v2

Follow this link to aranthorn's Instructions on how to get this to work.
https://vborg.vbsupport.ru/showpost.php?p=669033&postcount=231

Thank you aranthorn!!!

********************************

I sincerely hope that you enjoy this hack, Please feel free to send feedback to tnp@noblepagan.com!

To view this in action head over to: http://damn.that-sucks.net or http://www.noblepagan.com

Thank you!

)O( Cloudrunner )O(

P.s. Anyone who feels the need to donate to me (*hint hint*) feel free to do so, I won't stop you (yeah, I'm as greedy as the next guy). In fact we are a non-profit organization over at The Noble Pagan, so your donation would be tax-deductible .

LICENSE:

Originally Posted by Brandon J. Briggs aka. Cloudrunner

As the original author of the Paypal Hacks for vBulletin 3.0.x and 3.5.x I give full authorization to modify, recode, compile and/or reverse engineer the paypal donation hacks to any and all fully licensed members of vBulletin.org. I also give permission to fully distribute any derivative works that are created due to this authorization without need of providing credit or other means of recompense.

I am releasing this authorization in the hopes that someone will be able to carry on the work that was begun.

[majorj0nny]

Originally Posted by Cloudrunner

there is no such file within the donations system called 'modules.php'...so let's try again to be more specific on the problem at hand...

Secondly, be very certain that you did not try to install the 3.0.7 version of this hack and place it on a 3.5.0 board, or vice versa, it will not work.

Thirdly, line 14 is a commented placeholder in the code on ./donate.php for the latest version of this hack for both vb 3.0.7 and vb 3.50

PHP Code:

// ####################### SET PHP ENVIRONMENT ########################### 


so I'm not seeing how you are getting an error on that specific line.

As far as for version two of vbacmps, please, kindly, don't insult yourself by showing me that you are illiterate or lazy; we have covered that in the first post of this thread, which is displayed on each and every page of this thread.

Im getting this fault too - but unlike the other guy who found his files were swopped around - im certain mine are as in the directoryu structure of the original download I did last week.

the donate.php is roughly 10k in the forum root, the one in the modules folder is about 3k, im running vbulletin 3.0.8 and VBA 2

[Mastar]

HOw do I start the installation??

[Cloudrunner]

Originally Posted by majorj0nny

Im getting this fault too - but unlike the other guy who found his files were swopped around - im certain mine are as in the directoryu structure of the original download I did last week.

the donate.php is roughly 10k in the forum root, the one in the modules folder is about 3k, im running vbulletin 3.0.8 and VBA 2

Hey folks, sorry bout the lag off on my part, it's due mostly to personal issues as well as being on the disaster recovery team with my employer, so I've spent quite alot of time "Down South" over the last month or so...

Anyway, they have given me a reprieve from travelling for awhile, and I'll look into some of the problems ya'll have been having. Please don't get all frustrated and upset if I'm not around all the time, I do have a life outside the computer, and I am not always on the thing, plus I cannot promise that I won't be on a flight tomorrow to recover and rebuild hospitals in Texas, Louisiana again as I have been over the last month.

Now, as for the rrors that folks seem to be having with the advanced module, first make sure that in your settings for the donations state to view the donation module. If you do not have that set to yes, the thing will never display the module, also make sure that your other settings for donations are as they should be for your specific site. I included alot of settings for the donations that will remove the functionality of some of the things that PPD does with one simple click on the settings. Please be as specific as possible when descibing your problem, use three pages of text if you have to, I am not a mind reader, nor do I have the ability to wave my magic pink faery wand and see into my crystal ball exactly what you are experiencing unless you put it in plain english for me.

Now on a side note, I have been away quite abit, and will continue to be away off and on, I cannot promise that I will be able to support this hack any longer in the way that I used to. That being said, I am removing the supported check box on the thread; should you have a question or problem with this version, ask, be specific in your descriptions, and I will do my best to help when I can but as of this point, there are no promises being made. As well, I am not going to be adding any features for this version of the hack since 3.5 is nearing completion and gold status, but I am also not releasing any version for 3.5 beyond what I already have until vb has hit gold status.

However, I will keep you updated on progress better of the new gold version of PPD.

)O( Cloudrunner )O(

[Cloudrunner]

I make new goals every month.

I have one question. If someone donates, why isint the goal updating itself? Everytime someone donates, I have to manually update the goal.

Now it seems ok because there arent so many donators, but if alot of people start donating, there is no way to keep track of ALL of them.

Is there a solution for this?

you must assign a goal to the button for it to track the goal's progress, if you change the goal every day, then you must change the button every day as well.

[Cloudrunner]

Originally Posted by msimonds

This is a great hack and got it installed without a problem, OUTSTANDING Cloudrunner

One question though, I am paypal verified and when i click on the verified link, it takes me to paypal but wants me to sign in before i can view that I am verified. I thought that anyone was allowed to click on this and see that the owner of the site is verified
http://www.sportsrant.com/forums/donate.php


Am i doing something wrong


Regards
Mike
Sportsrant.com

Honestly, I don't know on that question sir, seems to me that would be an issue to take up with PP themselves.

[Cloudrunner]

Originally Posted by mholtum

I seem to be working fine except when Paypal trys to go to /ppverify.php I get this error message.

Database error in vBulletin 3.0.8:

Invalid SQL: INSERT INTO donation_paypalipn (
                                       `txn_id`, `userid`, `test_ipn`, `notify_version`, `verify_sign`,
                                       `first_name`, `last_name`, `payer_business_name`, `address_name`,
                                       `address_street`, `address_city`, `address_state`, `address_zip`,
                                       `address_country`, `address_status`, `payer_email`, `payer_id`,
                                       `payer_status`, `business`, `receiver_email`, `receiver_id`,
                                       `item_name`, `ip_address`, `quantity`, `invoice`,
                                       `memo`, `tax`, `option_name1`, `option_selection1`, `option_name2`,
                                       `option_selection2`, `payment_date`, `parent_txn_id`, `txn_type`,
                                       `payment_type`, `payment_status`, `pending_reason`, `reason_code`,
                                       `mc_gross`, `mc_fee`, `mc_currency`, `mc_handling`, `mc_shipping`,
                                       `settle_amount`, `settle_currency`, `exchange_rate`, `case_id`,
                                       `case_type`, `case_creation_date`, `valid`
                                       ) VALUES (
                                       '', '0', '0', '0', '',
                                       '', '', '', '',
                                       '', '', '', '',
                                       '', '', '', '',
                                       '', '', '', '',
                                       '', '', '0', '',
                                       '', '0', '', '', '',
                                       '', '', '', '',
                                       '', '', '', '',
                                       '0', '0', '', '0', '0',
                                       '0', '', '0', '',
                                       '', '', '0'
                                       );
mysql error: Duplicate entry '' for key 1

mysql error number: 1062

Date: Thursday 08th of September 2005 02:44:05 AM
Script: http://www.ravensrealm.net/forum/ppverify.php
Referer:
Username: mholtum

anyone have any clue as to how I maight fix that?

Delete your blank transaaction in your DB.

[Cloudrunner]

Originally Posted by ericgtr

This is a great mod and I appreciate all the time CR put into it. The only bummer is that it does not update itself automatically so you have to manually add each user and update the goal, steps that I don't know make it worth it. I have went through the install instructions over and over. Still, there are a lot of neat features with this mod.

Since so many others are also having this issue maybe the part of the features that says "Automatic updates EVERY time a user donates or retracts a donation." should be pulled so it doesn't give the wrong impression.

I'm not pulling that, because if you have the system setup properly, it will auto update everytime.

By this I maen:

1) have a goal
2) have a button
3) have that goal assigned to that button
4) the user is logged in
5) the donation is made by clicking the button
6) the user completes the transaction by coming back to your site

After you create the button / goal, it is ALWAYS good practice to go back and verify that something did not hiccup during the creation of the thing. It's very simple to do, just click edit on the goal or button and make sure everything is as it should be. If the associations are not correct, the stuff will break.

Now, that being said, I cannot promise that IPN has not changed its protocol slightly in the last two months as I haven't even glimpsed at this hack for approximately that long, but I will look into the auto update not happening for you guys. Everyone needs to understand that as soon as 3.5 goes gold, I will drop support for this completely 100%, right now I'm only supporting this thing at 25%, even less while I was out and about for the company.

[Cloudrunner]

Originally Posted by Mikecp421

Ok I figured out my problem. There is no ACP link to the donation_admin.php file so I had to manually go to it and was able to get it working. How can I make it available through the ACP?

You didn't do all the file edits as required boss, there is a quick edit to the index.php file in the admincp that places the donations admin on your navbar.

[Cloudrunner]

Originally Posted by majorj0nny

im having problems with this - Ive done a clear install never before had this on, its ran through the installation without any obvious errors, etc - but for some reason I cant see my VBA module - its there - but all the viewing permissions are set to NO ... if I try to set them to YES (so I can see the module) it comes back with an error


Could not find phrase 'adv_portal_must_choose_0_include'

?

Alright, for everyone freaking out about the module issue, here's the problem, I did NOT design a module for vBadvanced CMPS 2.0. The module was designed for 1.0.

That being said, it shows me just how lazy some folks are to read the information placed in the first post (majorj0nny), seems that the loudest one of all is also the one who did NOT read.

That error that everyone is complaining about (can't find the phrase 'adv_portal_must_choose_0_include') is an error of the vBadvanced 2.0 system trying to read the 1.0 module inproperly.

Not that I have figured ya'lls problem out, check the first post and read the whole thing., better yet, I'll quote a user from a couple of pages back

i had the same problem. so i deleted the existing "donations" module and created a new one based on ARANTHORN'S POST

and now it works perfectly

my config:
vbadvanced v2.0
vbulletin 3.0.8

Now for aranthorns post, you will need to read the first post, it is there, and listed as the fix to your problem, it has been listed for a long time there MJ. In fact, I'm highly confused as to how you could miss it, as it's in REALLY BIG LETTERS.

Now if you do those steps as listed by aranthorn, and it still doesn't work, then please, by all means, post your issue here and I will do what I can.

* Cloudrunner walks off grumbling to himself on whether it is too much to ask for people to read...

[Cloudrunner]

Now that I think we've addressed everything, I'm going to rant abit...

While it's not my requirement to tell everyone what is going on in my life, it is my responsibility to everyone to support this thing, because I said I would. In that I have not done so in the last two months. The last month I have been in Louisiana, but for the month previous I have no excuses other than personal issues. Even so, although it is required for me to provide support here, I'll be honest folks, I'd rather not. The reason is that now that I'm home I'm working on the 3.5 version of this thing, and would like to put my efforts into that version of the software. I do not even use 3.0.x anymore on my sites, nor do I want to, but seeing as I said I would support this version, I will to the best of my abilities.

Until 3.5 goes gold. Be ready for that folks, as soon as 3.5 goes gold, I will drop this version like a sack of rocks. This is the warning now, so what you see is what you get as of this point, I'm not going to add functionalities, nor toys to this version. Nor will I visit this thread after that time.

This is just a forewarning.

)O( Cloudrunner )O(