Quoteme V1.1

Table of contents

1.     Preface

1.1  System requirements
1.2  License
1.3  Support

2.   Using the ad engine
2.1 Changing variables
2.2  First run
2.3  Customizing
2.4 Admin Functions

3.    Links

4.   Licensing form

A1 In the works....

 

 

Preface

 This ad engine was created out of the need to have a secure and reliable server for quotes and sources needed by journalists. It is mostly geared to companies or organizations that need submissions under one category and present them in a long list. It also needed some unique features, like what we called the shitlist while programming (and it kept the name).  

The shitlist is basically a tool designed to deny service to computers from which unwanted and/or illegal content is constantly submitted. It records the computers unique ID on the Internet (called IP Address) and denies access to the ad engine if the request comes from one of these computers. 

The system administrator has also the possibility to review ads and changes made through the admin area, where unwanted content can be deleted.

The reason why this program is made available as SHAREWARE is more or less popular demand.

 

1.1 System requirements
Quoteme 1.1 should run under any server that works with PHP and mySQL. It was tested under Apache (Windows and LINUX) and XITAMI (Windows) , PHP V4. and mySQL V1.3.

 

1.2 License
Quoteme 1.1 is Freeware, that implies that it should also be distributed for free.

1.3 Support
All licensed users can require support to customize Quoteme V1.1 and help when bugs are discovered and to receive free updates when faulty programming requires it as well as one update to the next version. There are no warranties expressed or implied  beyond this commitment. Major re-designing and adaptations cannot be made by the publisher without additional payments, please contact laugh@otenet.gr  for enquiries and prices.

 

Using the ad engine

The ad engine is supplied exactly in the form it is working on Quote me... (http://www.quoteme.f2s.com). It is expected that the user customizes the HTML content (index.html) and the background. There are other steps needed to be taken before the system can successfully be implemented on a server as described below.

2.1 Changing variables
Open the file index.php with an editor and change the black content of the lines highlighted in red in this document (note that we only show part of the 1100+ lines of Quoteme) :

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<?php

# all needed subprograms

# all needed variables

# mySQL login
$db_name ="name_of_ad_databank";
$db_sname = "name_of_shitlist_databank";
$db_user ="user_name_on_mySQL_server";
$db_hostname = "the_host_name_for_the_databank";
$db_password = "your_databank_password";
$db_table = "databank_table_name";
$db_stable = "shitlist_table_name";

#admin security
$admin_secure="admin";
# email address of site admin
$webmaster="your_e-mail";
# notification of submission to admin set to (options are yes or no in small caps!!!)
$emailme="yes";

Be especially careful to leave all quote marks (") and semi-colons(;) in place, else your script will cause a parse error message (If you get a Parse Error on line 25 most likely you have deleted the quotes or semi-colon on line 24 or above). Once these variables have been set to your system you should be able to run the script.

A special note must be made for the $admin_secure password. The content of this variable should not be to easy to crack as it provides the (potential) hacker with total control over your ad site -- up to the point that he/she could ban you from your own site! In a future release of Quoteme there will be a module that precludes service to a user that tries to enter the admin area with a wrong password for the third time, but at this time it is just would add a new problem to those who are putting up their sites.  

 

2.2 First run
The first run should be by invoking the admin area after the ad engine has been uploaded to your site. This can be done by calling:
http:// [your web address] /index.php?action=[your $admin_secure password(see above)]. So if your web address is myweb.com and your admin password is #!@*&^%(sorry, but you must use numbers and letters!) the browser address is http://myweb.com/index.php?action=#!@*&^%.

Besides a few warnings that databanks cannot be reached you will get to the Admin Area of your ad site. There you have an options field and a submission button.

Choose the option create to create the tables and your databank(s). Note that if you invoke create for the second time you will receive an error message. If the response of the server is the same error message as during the first run it is likely that you are using a browser from the Dark side (a.k.a. Microsoft®) that tends to show the old screen assuming that the result would be the same because the script file has not changed. Hitting the Refresh button while holding the shift key will show you the right results.

It is good to choose the edit and shitlist functions at that time to ensure that the databanks have been created. If you receive no error messages and no warnings after invoking these functions you are ready to go live.

 

2.3 Customizing
All html documents can be changed with html editors such as htmledit, PROTON, or if you can't help it FrontPage®. Customizing the script is a little more difficult and besides the variables only those who know what they are doing should change anything between the lines <?php  to  ?>. The links to perform script functions should be:
                To show ads:   ... index.php?action=view
               
To submit ads:  ...index.php?action=submit&B1=null
                To edit ads       ...index.php?action=edit&B1=null
               
For admin        ...index.php?action=(your password)

as long as the word after action reflects the right function the script should work, but will show error warnings if B1 is not specified.

 

2.4 Admin functions
The admin area is pretty straight forward.

edit leads you to a screen that shows each ad separately with all variables. If there are ads you will see the first ad and a navigation bar where you can go back to the previous ad (if there is one) or forward to the next ad. Additionally there are two red fields, DELETE and SHITLIST on this bar. 
Delete initiates the deletion of the ad on the screen. It will take you to the next screen where you will be asked if you really want to delete the ad (as sometimes it could be chosen by mistake). If you don't want to delete choose the GREEN link, or the RED link if you do. 
Shitlist includes the IP of the ad on screen to the exclusion of service list, but asks you to specify a reason, which will appear on the SO SORRY screen the next time the banned user logs in. After you submit that screen you will be asked if you want to delete the ad.

shitlist shows you all entries on the banned user list and you have the option to edit and delete the entries. Just hit the appropriate links on at the end of the screen to add an IP or return to admin,  or click on the number on the line showing the banned IP to edit or delete.

create creates the databanks after the first run or in the unlikely event that you should loose your data banks after a server crash.

tables shows you the name of the tables active in your databank.

 

Links

For information and tutorials on PHP you may have a look at http://www.php.net
For information and tutorials on mySQL you may look at http://www.mysql.com
For updates of Quoteme you can see my scripts page http://www.alfsscripts.freeservers.com

 

 

Licensing Form

No special form is needed to license Quoteme, just send an e-mail to a alf@kafeniocom.com specifying the site you plan to use it on and if you represent a non-profit entity. 

 

Planned improvements

At this point the following improvements (to do list) are planned for a future version of Quoteme: