#!/usr/bin/perl -wT
#
# This is the CGI that processes the form return from GPS information form.
# It's in Perl rather than Python because Berlios and many other sites
# don't support Python CGIs.
#
use CGI qw(:standard);
use CGI::Carp qw(warningsToBrowser fatalsToBrowser);
use MIME::Base64;
use MIME::Lite;
use Net::SMTP;
use strict;
# All information on the project siting, mailing
# lists, and originating host lives here.
my $website = 'http://gpsd.berlios.de';
my $to_address = 'gpsd-dev@berlios.de';
my $servaddr = 'www@mainframe.cx';
my $query = new CGI;
print $query->header;
print $query->start_html(-title=>"GPSD Receiver Reporting Form",
-background=>"../paper.gif");
my $output_sample_file = $query->param('output_sample');
my $output_sample_body = $query->param('output_sample_body');
$output_sample_body = '' unless ($output_sample_body);
do {
local $/ = undef;
my $x = <$output_sample_file>;
$output_sample_body = encode_base64($x, "") if ($x);
};
if (hasNeededElements($query) && $query->param("action") eq "Send Report"){
# handle successful upload...
### mail parameters
my $from_address = "HTTP Server <${servaddr}>";
my $mailhost = '127.0.0.1';
my $subject = 'new gps report';
### Create the multipart container
my $email = MIME::Lite->new (
From => $from_address,
To => $to_address,
Subject => $subject,
Type =>'multipart/mixed'
) or die "Error creating multipart container: $!\n";
### build message text
my ($var, $val, $msg);
$msg = "Remote: ${ENV{'REMOTE_ADDR'}}:${ENV{'REMOTE_PORT'}}\n\n";
$msg .= sprintf("[%s]\n", $query->param('model'));
$msg .= sprintf("type = device\n");
foreach $var ( sort qw(submitter vendor model packaging techdoc chipset
firmware nmea interfaces tested rating noconfigure
location date notes sample_notes)){
$val = $query->param($var);
$msg .= sprintf("%s = %s\n", $var, $val) if (defined($val) && $val);
}
### Add the text message part
$email->attach (
Type => 'TEXT',
Data => $msg,
) or die "Error adding the text message part: $!\n";
### Add the sample
$email->attach (
Type => 'application/octet-stream',
Data => decode_base64($output_sample_body),
Filename => 'sample.bin',
Disposition => 'attachment',
Encoding => 'base64'
) or die "Error adding sample output: $!\n";
#MIME::Lite->send('smtp', $mail_host, Timeout=>60, Debug=>1);
#$email->send;
$email->send('smtp', $mailhost, Timeout=>60, Debug=>1);
print "new gps report accepted...\n";
exit(0);
}
print $query->start_multipart_form;
print < Please use this form to report Fields marked Important! have to be filled
in for the report to be useful. These are: submitter contact address, vendor,
model, documentation URL, and output sample. Other fields represent things we
might be able to find out ourselves, but which are easier for you to determine.
Every bit of information you can give us about your receiver will help make the
support for it more reliable. Important! We prefer a valid email
address for you in case we need to ask you followup questions about
the device. While we won't use your address for anything other than
asking you questions about your receiver, and maybe asking you to test
specific changes, this gps report will be sent to the gpsd-dev list
which is publicly archived.
gpsd
successes or
failures with GPS and AIS units, and also to upload a sample of the receiver's
output so we can add it to our regression tests and ensure continued
support of the device.
Contact information
Example: Eric Raymond <esr@thyrsus.com>
Important! Identify the vendor and model of
your device.
Example: Haicom
and 303S
.
Vendor:",$query->textfield(-name=>"vendor", -size=>72),"
"; print "Model:",$query->textfield(-name=>"model", -size=>72),"
"; print <http://www.haicom.com.tw/gps303s.shtml
URL of a technical manual:
EOF
print $query->textfield(-name=>"techdoc", -size=>72);
print < Packaging: Chipset:",
$query->textfield(-name=>"chipset", -size=>72)," Firmware:",
$query->textfield(-name=>"firmware", -size=>72),"
EOF
print $query->radio_group(-name=>'packaging',
-values=>['mouse', 'handset', 'handsfree',
'survey', 'OEM module', 'chipset', 'other'],
-default=>"mouse",
-linebreak=>'false');
print <xgps
; look for
a Device Type field or at the window title bar. Alternatively, you may find
it in the technical manual.
Example: SiRF-II
and 2.31ES
.2.0
, 2.2
, and 3.0
.
If the GPS emits only a vendor binary protocol, leave this field blank.
Please identify the receiver's interface type (USB, RS-232, Bluetooth, Compact Flash, etc.). If the receiver has adapters that support other interfaces, tell us the one you have and mention the adapters in the "Technical Notes" box. If it has an exotic interface not listed here, select "Other" and tell us about it in "Technical Notes".
EOF print $query->radio_group(-name=>'interfaces', -values=>['USB', 'Serial', 'Bluetooth', 'TTL', 'Compact Flash', 'RS-232', 'Other'], -default=>"-", -linebreak=>'false'); print <lsusb(1)
. Likely values are PL2303
,
UC-232A
, FTDI 8U232AM
, Cypress
M8
or Silicon Labs CP2102
.
EOF
print"USB-to-serial chip:",$query->textfield(-name=>"usbchip",
-size=>72);
print <Please tell us what version you tested with. If you used us a release,
give us the full release number, like 2.35
. If you built
your code from our development repository please give the revision ID.
Now tell us the things that didn't fit in the rest of the form. Appropriate things to put here include how to read any LEDs or other unlabeled indicators on the device, a warning that the product has been discontinued, a list of alternate interfaces, descriptions of errors in the documentation, applicable PPS offsets, descriptions of special abilities such as the ability to vary the sampling interval, and a note if it's an OEM module rather than a retail product. Anything else you think we need to know should go here too.
EOF print $query->textarea(-name=>"notes", -rows=>10, -cols=>72); print <Important! We need a sample of the output from your receiver - not the gpsd logfile, just raw output. We'll use this for mechanical regression testing, which is your best guarantee that support for your device won't get broken in a future release. Please be advised that these logs will be sent to a publicly archived mailing list, and will be available in the public code repository.
Almost all receivers will simply start throwing data to your port
immediately when they're plugged in. You should normally be able to capture
this output to a file with the gpscat
utility.
There will be some unusual cases in which this isn't possible, because the device needs some kind of activation sequence written to it before it will start reporting. Some Garmin GPSes (the ones that speak Garmin binary protocol rather than NMEA) are like this. If you think you have one of these, ask the GPSD developers for help.
A log file is most useful when it contains (a) some sentences generated when the receiver has no fix, (b) some sentences representing a fix with the unit stationary, and (c) some sentences representing a fix with the unit moving.
EOF print $query->filefield(-name=>'output_sample', -size=>72); printf("\n\n", $output_sample_body); print <Location of the log capture. A good format would include your
nearest city or other landmark, state/province, country code, and a
rough latitude/longitude. A GPS will give an exact location; we
want this as a sanity check.
Example: Groningen, NL, 53.2N 6.6E
2011-05-14
.
EOF
print"Date:",$query->textfield(-name=>"date", -size=>72);
print <Thanks for your help. Here is a summary of the information you have entered so far:
EOF print "";
if ($query->param("submitter")) {
print "Contact address is ". escapeHTML($query->param("submitter")) ." \n"; } else { print "No contact address. \n"; } if ($query->param("vendor")) { print "Vendor is ". escapeHTML($query->param("vendor")) ." \n"; } else { print "No vendor. \n"; } if ($query->param("packaging")) { print "Packaging type is ". escapeHTML($query->param("packaging")) ." \n"; } else { print "No packaging type specified. \n"; } if ($query->param("model")) { print "Model is ". escapeHTML($query->param("model")) ." \n"; } else { print "No model specified. \n"; } if ($query->param("techdoc")) { print "Document URL specified. \n"; } else { print "No document URL. \n"; } if ($output_sample_body) { print "Output sample uploaded"; } else { print "No output sample. \n"; } print " | ";
if ($query->param("chipset")) {
print "Chipset is ". escapeHTML($query->param("chipset")) ." \n"; } else { print "Chipset not specified. \n"; } if ($query->param("firmware")) { print "Firmware is ". escapeHTML($query->param("firmware")) ." \n"; } else { print "Firmware not specified. \n"; } if ($query->param("nmea")) { print "NMEA version is ". escapeHTML($query->param("nmea")) ." \n"; } else { print "NMEA version not specified. \n"; } if ($query->param("interfaces")) { print "Interface type is ". escapeHTML($query->param("interfaces")) ." \n"; if ($query->param("interfaces") eq "USB") { if ($query->param("usbchip")) { print "USB chip is ". escapeHTML($query->param("usbchip")) ." \n"; } else { print "No USB chip specified. \n"; } } } else { print "No interface type specified. \n"; } if ($query->param("tested")) { print "Tested with GPSD version ". escapeHTML($query->param("tested")) ." \n"; } else { print "No GPSD version specified. \n"; } if ($query->param("rating")) { print "GPSD compatibility is ". escapeHTML($query->param("rating")) ." \n"; } else { print "No GPSD compatiblity specified. \n"; } if ($query->param("noconfigure")) { print "Device can be sent catatonic by baud-rate changes \n"; } else { print "Device handles baud-rate changes correctly \n"; } print " | ";
if ($query->param("notes")) {
print "Technical notes have been entered. \n"; } else { print "No technical notes. \n"; } if ($query->param("location")) { print "Sample location ". escapeHTML($query->param("location")) ." \n"; } else { print "No sample location specified. \n"; } if ($query->param("date")) { print "Sample date ". escapeHTML($query->param("date")) ." \n"; } else { print "No sample date specified. \n"; } if ($query->param("sample_notes")) { print "Notes on the sample have been entered. \n"; } else { print "No notes on the sample. \n"; } print " |
To refresh this summary, click Review
\n";
# Must have all critical fields to ship
if (hasNeededElements($query)){
print <Send Report
button to
send your report to the GPSD developers. Eventually, your report is
likely to appear on our Hardware page.
Reset Form |
Review
.
Reset Form |