Talk:Import CSV data into a wiki

Description

csv2wiki is a way to import data from a CSV file into a wiki running mediawiki. There are two versions of this program. The first is a command-line driven version written in the Perl language. The second is a PHP version that runs as a MediaWiki command-line maintenance script so that it can integrate directly with the wiki database instead of working via HTTP requests.

• Linux.com article (also available in Japanese)

How It Works

The script uses wiki.pl to login and edit wiki articles

Job File

The job file contains all the information necessary to update your wiki from content in a single Source File. The structure of the job file is a \n delimited list of key value pairs. Fields in the job file include:

• csv: Source File #full path and file name
• wiki: http://mydomain.com/wiki/index.php5 #wiki URL (must be long form including the index.php
• user: username #an active user on the wiki
• pass: password #user's password
• separator: # the double quoted delimiter between records e.g. ",", "\t" etc (default is comma, this is a regular expression, so you can use it to remove white-space, eg \s*,\s* or specify tabs with \t)
• title: n # the column number that gives the article it's title (perl indexing starts from 0)
• template: # defaults to Template:Record if there is none
• prefix: # A prefix appended to the beginning of article names, defaults to ''
• append: # A logial to either overwrite or append to an article, default=0 (overwrite)

For example the job file could contain:

csv: MyMileToParse.txt
wiki: http://mydomain.com/wiki/index.php5

etc. The : is critical as a key value separator

Source File

• Unicode: Ensure that the CSV file is encoded in UTF-8 if it contains special characters

Template

A nice approach would be for the script to fetch the template intended for use on the wiki using the persistent template:' argument in the job.txt file. The Csv2wiki.pl script can then parse out all the {{{params}}} which are not between <noinclude>...</noinclude> tags from a required template, since any content between those tags is not acted upon during transclusion of the template intances. The script can then obtain a list of template parameters and check them against the column names of the input file. Using this information the uploaded template wikitext calls can be restricted to a subset of columns of interest out of the input file. e.g.

Input has columns: Foo Fodda Fum fi From template:Foo;

{{Foo|1= |2= |fodda=|fi=123}}

Column Fum is not uploaded as it is not in the template definition.

Approach

1. It needs to find a template as input, if it doesn't exist then it throws a warning and uploads everything, it then uses wiki.pl to fetch the article wikitext.
2. It parses through the template and grabs all {{{params}}}
3. Th columns are matched between the unique template parameters and the infile columns

Todo

Most of the template uploading functionality has been written.

• Add a prefix: argument which adds to the beginning of article names.
• Add the use strict pragma

Windows

If you are needing to run Csv2wiki from a Windows machine, you will first need to install Active Perl. Refer to their site for documentation.

Install and Run

• Copy your job description file (eg job.txt) to the same directory as the csv2wiki.pl and wiki.pl scripts
• Open up a command prompt
• change to the directory containing the csv2wiki.pl script

perl csv2wiki.pl job.txt

• you can run multiple jobs at the same time by opening multiple cmd windows in windows. Make sure the jobs are different!

Issues

• what is the delay time for logging in? (troubleshooting a slow server)

Login should take about a second

Tips

• Open in excel
• copy spreadsheet and paste special as values only (gets rid of formulas) and resave
• remove or replace all "," characters in file
• save excel spreadsheet as Unicode Text
  • Save As, Save as Type, Unicode Text (*.txt)

• Open and Edit text in Geany (better than notepad),
• search and replace TAB character with "," (cut and paste a tab character from notepad to get this)

NOTE, if you want to use tabs, set separator to \t

• set unicode type (Document, Set encoding, Unicode, UTF-8)
• save

Append/Overwrite

• how does the script indicate if it should overwrite or append?

Currently this script does not append, it always overwrites an existing wikipage. The code that does this is;

{{{1}}}

however it could easily be modified to do so by adding a conditional to allow appending of article content aswell using wikiPageAppend($::wiki,$::prefix . ...) instead. A new field would have to be added in the input file to signal that appending of content is required --Sven 11:57, 22 June 2008 (NZST)

Now implemented append, overwrite, could also implement wikiUpdateTemplate too. --Sven 22:03, 22 June 2008 (NZST)

swell, thanks for updating the example job file, too --Phalseid 17:17, 23 June 2008 (NZST)

Future fork

This script could be more generic by adding in parser rules which define what the record structure is of any file the script is uploading into a wiki. The idea is to maintain a set of parsing rules as defined by a template. For the instances of the template= parameter in the job.txt script the <noinclude> sections should provide information about the parsing rules regular expressions e.g.

Record: m/^(.+?(\t|\n))$/g;

$1 = m/(.+? ).+?/;

...

The record describing regular expressions output can be the input to another regular expression for each parameter of interest to capture. These would be named as 1= etc in the template. Security issues need to be addressed around the /.../x regular expression option, which needs to be suppressed using a search and replace regular expression itself for each regular expression specified.

bug

if "*append: 0 " it exits without overwriting the file.

i think it should have three settings:

• append 0 create if new, skip if present
• append 1 create if new, append if present
• append 2 create if new, overwrite if present

--Phalseid 08:34, 12 July 2008 (NZST)

I will look at your suggestions, currently wikiPageEdit always overwrites all content. If the new content is the same as the current content then the edit will not be made,. WikiPageAppend currently appends content if new key/value parameters are present --Sven 08:31, 16 July 2008 (NZST)

sorry i missed you on skype. does it overwrite all page content, or just for the named template? i can't tell because it just seems to skip if 0. --Phalseid 08:59, 16 July 2008 (NZST)

Is the content new? Because both wikiPageEdit and wikiPageAppend probably dont add anything if there is no change in article content -Sven 20:43, 16 July 2008 (NZST)

Did another test yesterday, and it is definitely working, for '*append:0' and '*append :1', one possibility is that the CSV file had and error in it which the perl script did not detect, but processed anyway. Thinking about the options, articles will be skipped if the content is the same anyway so that option is redundant. However, the function 'wikiUpdateTemplate' in Wiki.pl might be a good option to add. So you have the ability to overwrite, append, and just update the first matched template. --Sven 08:44, 13 August 2008 (NZST)