root/dev/mods/value_fetch/readme.txt @ 491

Revision 486, 6.6 KB (checked in by kovell, 11 years ago)

Fixes: Default value_fetch modified to use CTL's pricing xml.

Line 
1Value Fetcher Mod - Updated by ChaseTheLasers 05/2009 - 0.1 Beta
2Original work by Beansman, with updates done by Penthux. Original Readme below.
3
4
5DISABLE ANY OTHER PRICE UPDATING MODS BEFORE RUNNING
6
7
8
9Q. So whats changed?
10
11A. Not a lot. Sadly the site at http://svn.nsbit.dk/itemfetch/ has been down for a while
12making prices on the killboard outdated. I have created my own version of this site from
13scratch so the files can be used with the "value_fetch" and "value_fetch_pwu" mods.
14
15Corrections have been made to fetch_values.php (line 8) and cron.php (line 23) to stop
16it calling the wrong mod directory. If you use the old version of value_fetch_pwu it
17will make calls to the default 'value_fetch' mod.
18
19
20Otherwise all that has changed in this 'release' is the URL locations to fetch the files from
21my server. Updating the prices in your killboard is now a matter of hitting "fetch" again.
22
23Hurrah!
24
25
26
27
28
29Q. I can't use fopen() on URLs as my host blocks it. Can I still update the values?
30
31Q. I get errors like:
32Warning: fopen() [function.fopen]: URL file-access is disabled in the server configuration in <location> on line 40
33
34
35
36A. Sure can =)
37
38Download the "local update" zip from http://www.ekchu.com/dev/ and unzip the
39contents to the root of your killboard. This means if your killboard is located
40at http://www.yourcorp.com/killboard/ you should be able to access the files by
41typing in http://www.yourcorp.com/killboard/items.xml and
42http://www.yourcorp.com/killboard/items.xml.gzphp in your browser. Once these files
43are uploaded, open up fetcher.php from the "value_fetch_pwu" mod and change lines 21
44and 22 to look like this:
45
46        var $compfile = "items.xml.gzphp";
47        var $uncompfile = "items.xml";
48
49No other changes are needed.
50Save the fetcher.php file and upload it to the "value_fetch_pwu" mod directory, overwriting the
51current one.
52
53The "local update package" contains exactly the same 2 files that are hosted on
54my server (items.xml and items.xml.gzphp) apart from they are zipped to save bandwidth.
55Please use the zipped version if you plan to reupload them to your server =)
56
57ChaseTheLasers =)
58
59
60
61
62=====================================
63Value Fetcher Mod - personal webspace update version by Penthux (penthux.co.uk)
64revision date: 2008.12.21
65
66
67Based on Value Fetcher Mod by beansman - http://svn.nsbit.dk/itemfetch/
68
69Credits: eve-dev.net (Eve Dev Killboard original code) - http://www.eve-dev.net
70         beansman (Value fetcher Mod) - http://svn.nsbit.dk/itemfetch/
71
72
73=====================================
74
75What does Value Fetcher - 'personal webspace update version' do?
76
77Same thing as the original version does! It updates the values in your eve-dev.net
78killboard for ships and faction items but it updates from your own domain rather
79than beanman's http://svn.nsbit.dk/itemfetch/ site.
80
81
82Why modifiy existing files if they are already working?
83
84In the event that your hosting company, or ISP, (like mine) has firewall rules
85in place which do not allow you to download files from remote locations/servers,
86or has a restriction on the size of files that you can download, this can severely
87compromise the ability to use the Value Fetch Mod to update values on your killboard.
88
89
90What's changed?
91
92fetcher.php - Added some brief comments on prerequisites before using this mod.
93URL paths to items.xml.gzphp and items.xml (after editing) now point to a location
94on your personal webspace instead of http://svn.nsbit.dk/itemfetch/
95
96fetch_values.php - Rephrased some of the message text after the update. Added a
97"back" button so it's easier to navigate if the import fails, or for any other
98reason(s).
99
100settings.php - The link to the forum thread (Mod version) was out of date so it was
101updated this to the current correct URL. Also added a link "Check for latest updates"
102which points to beanman's site (http://svn.nsbit.dk/itemfetch/) for ease of downloading
103the XML files so they can be uploaded to your own personal webspace for importing.
104
105** The rest of the code in all files is unchanged.
106
107
108=====================================
109
110How to use this modification:
111
112You need to unpack the files and open fetcher.php in your favourite text editor. Then
113near the top of the file you will see this code:
114
115// download the items.xml.gzphp and items.xml files from http://svn.nsbit.dk/itemfetch/
116// upload them to a directory on your own webspace
117// modify the two paths below to point to the downloaded files
118var $compfile = "http://<your_path_to>/items.xml.gzphp";
119var $uncompfile = "http://<your_path_to>/items.xml";
120
121Download the XML files from beanman's website, upload them to your own webspace and
122change the <your_path_to> part to suit your own domain/path to the files. Then upload
123the entire value_fetch folder to your /killboard/mods/ directory.
124
125Login to your killboard as admin and click on the modules link. You will see there is
126now a value_fetch mod available in the list. Tick the box on the right to activate the
127mod and then click the"SAVE" button at the bottom. The page will refresh and then you
128should click on the "settings" link next to value_fetch in the mod list.
129
130Now you are presented with the value_fetch interface. Make sure you select the correct
131version of PHP installed on your domains server before you click the "Fetch" button.
132If you have uploaded the XML files, and changed the paths in fetcher.php to point to
133those two files correctly, you should have a successful update.
134 
135==================
136
137
138[Personal Notes]
139
140The reason I made this modification is because two other people I know, and myself,
141have issues with our hosting companies/ISPs who block our ability to use PHP in order
142to access remote information or download files on our domains. I had to grab files from http://svn.nsbit.dk/itemfetch/ and upload them to my own webspace and modify the existing
143PHP code to import them into the MySQL database to get around this problem. This
144modification is a work-around to that problem and the end result is the same - updated
145values on your killboard. The only difference really is that you'll be using up your own
146bandwidth instead of beanman's, which i'm sure he will not be unhappy about. LOL! :D
147
148If there are any errors found I apologise in advance. This modification of value_fetch
149has been tested and works perfectly on my own killboard installation. Please let me know
150if you find any errors and I will endeavour to correct them asap.
151
152If you find this modification usefull then a couple of hours on a Sunday afternoon have
153been very well spent. Enjoy! :)
154
155
156Penthux
1572008.12.21
158
159
160
161
162
163
164
165
166
167
168
Note: See TracBrowser for help on using the browser.