Add QA check for valid time zones

Make sure every WX weather zone has an accompanying time zone and
that its value is a valid entry from the local TZDB.

Include time zones in WX weather zone data

Some NWS products, such as forecasts and other alerts, have
expiration times marked relative to the issuing authority's local
time zone. In preparation for being able to calculate expirations
accurately relative to the user's local time, embed IANA TZDB
compliant identifiers in all WX weather zone definitions, translated
from their NWS time zone codes.

Correlation files are all updated because of amending overrides
accordingly.

Overhaul alert URLs for current NWS usage

NWS switched to using FIPS based county designations for flood
warnings around 2016, so fix the URLs for them. Also flash flood
statements and warnings (but nor watches which, for some reason,
still use WX weather zones). Severe weather statements too (but not
special weather statements nor urgent weather messages). Oh, and
thunderstorms.

Add a new tornado alert type with relevant URLs, and fix
configuration examples which reference the older tornado_warning
field which hasn't been available for years.

While at it, remove the separate flood statement alert which seems
to be entirely unused by NWS.

Loosen alert/forecast expiry filter by 24 hours

Since NWS alerts and forecasts list their expiration times relative
to the issuing office's local timezone, filtering for expired
documents relative to the users timezone can lead to them being
filtered early when they're not both coincidentally the same.

Introduce a one day (86400 second) offset buffer as a simple
workaround for now, since the user's and issuing authority's
timezones shouldn't ever differ by more than that. This has a
downside of showing forecasts or alerts which have expired and not
been replaced, but that was possible already if timezones differed
in the other direction, and is preferable to the alternative.

The NWS DBX schema for WX weather zones does include a field for a
timezone code, so a future change may introduce more accurate
calculations in order to identify the relative offset between the
user and issuer, but this will require extending our own zones
format to add a new value for it.

Refresh correlation data

Switch to the 2023 US Census Bureau data, March 2024 NWS WX zones,
latest OurAirports open data set, refresh active forecast and
station lists, and clean up obsolete overrides. Regenerate all
correlation sets based on these updated sources.

Replace ConfigParser's readfp with read_file

Python 3.12 drops the deprecated readfp method from ConfigParser, so
use the newer read_file method instead.

Use raw strings for regular expressions

Python 3.12 requires raw strings for many character sequences used
in regular expressions. Originally submitted by Piraty, thanks!

Correct FAQ entry about condition filters

Condition filter customization wasn't documented quite right in the
FAQ, and got the space-to-underscore replacement situation
backwards.

Refresh correlation data

Clean up the overrides.conf a bit and regenerate correlations now
that the NWS has retired some WX weather zones. This addresses some
incorrect correlations to now dead forecasts in the Los Angeles
area (thanks to Chime Hart for reporting), as well as likely others.

Restore missing WX zones

Due to a filtering mistake when assembling the zlist file, 2.4.3
shipped with no NWS WX zone associations. Brown bag fix releasing as
2.4.4.

Prepare for 2.4.3 release

Switch to the 2022 US Census Bureau data, March 2023 NWS WX zones,
latest OurAirports open data set, and refreshed active forecast and
station lists. Regenerate all correlation sets based on these
updated sources.

Don't use U mode, removed in python3.11

This patch was helpfully submitted by Bas Couwenberg to drop use of
the universal newline flag, since Python 3.11 no longer supports it.
It probably breaks the ability to build new correlation files under
Python 2.7 and earlier, but since it shouldn't affect operation of
the utility with prebuilt correlations (the way it's typically
used), this isn't yet considered to drop Python 2.7 support
altogether.

Drop vestigial import of the tarfile module

The correlate() function stopped needing tarfile a couple of years
ago (version 2.4), but it was overlooked that the script continued
to unnecessarily import it. Clean this up.

Refresh correlation data

A new correlation data build, based on more recent active WX zones
(notably, the Los Angeles California area was re-zones earlier this
year).

Clean up .gitignore file

Remove the coop-stations.txt file from the ignore list, since it's
not been used for some time.

Force UTF-8 locale when reading configs and data

Apparently, Python on Windows defaults to assuming CP1252 encoding
unless otherwise specified, as opposed to the UTF-8 assumption made
on POSIX platforms. Since our configuration and data files are
expected to always use UTF-8 encoding, be clear in the
ConfigParser.read() calls about that. We only do this under Python
3.x, as that method doesn't have an encoding parameter in 2.7.

Thanks to Lance Bermudez for reporting this.

Refresh correlation data and update copyright year

Just a basic correlation update based on more recent active METAR
station and WX zone lists. Also update the copyright year for files
which have been edited so far in 2021 as well as in the LICENSE
file.

Correct handling of boolean selections

The selections proxy class, which mashes together command-line
arguments and configuration options, contained a longstanding and
fatal flaw with its handling of boolean values. In particular,
falsey values were consistently treated as truthy due to naively
recasting str to bool (which will always yield True unless empty).
This went unnoticed for so long because the majority of these
settings default to False, meaning the only reason most users had to
set them was to override them to True.

Many thanks to Jordan Russell for bringing this bug to my attention,
and for supplying an initial patch on which this fix is heavily
based.

Co-Authored-By: Jordan Russell

Refresh active station list and correlation data

Perform a fresh build of data sets from current sources, and add a
few additional overrides for previously unknown stations. Also
update from 2019 to 2021 US Census data, from March 2020 to
September 2021 CountyZone maps, and from 2020-08-29 to 2021-08-29
airport IDs and active METAR stations/WX zones.

Correct and simplify URLError exception handling

Julien Palard pointed out that the way URLError exceptions were
being manually cobbled into the stderr stream wasn't quite working
(thanks!), but it was also unnecessarily complicated for reasons I
don't recall now. Rip most of it out and just go with a basic
catch/error/re-raise there instead.

Prepare for 2.4.1 release

Update the version string in the project and manpages.

Refresh correlation data

Another data refresh, preparing for an upcoming release.

Update correlation data

Normalize the overrides, remove some stale overrides for defunct
stations, and regenerate the correlation data set.

Refresh active station list and correlation data

Perform a fresh build of data sets from current sources, and add a
few additional overrides for previously unknown stations.

Make missing alert URLs non-fatal

As a more complete fix and future-proofing for the earlier mismatch
between default_atypes and the alert URLs generated for WX zones
during correlation, stop aborting and simply add a warning if a
requested alert type has no corresponding URL.

Correct default_atypes to match what's generated

Kevin Monceaux reported a regression with the 2.4 release. Running
with the -a/--alert option and no limited --atypes or atypes
override in weatherrc resulted in a message about undefined URLs
and no normal output. This problem crept in when hard-coding alert
types in the correlator after ditching the woefully unmaintained
zonecatalog.curr.tar data source (commit 8a37edd).

Update default_atypes so that it covers all relevant non-forecast
URLs the correlate routine embeds.

Make the build reproducible

While auditing Debian's packages, Chris Lamb reported[*] that
weather-util's correlation set generation is not reproducible
because it embeds timestamps without a means to override them and
also varies by system timezone. Allow SOURCE_DATE_EPOCH from the
calling environment and assume UTC rather than relying on locale
settings when no timezones are specified.

[*] https://bugs.debian.org/964721

Update release notes and docs for 2.4 release

Get correlate() working in modern Python 3

Update a bunch of the parsing for various correlation source files
to work in both Python 2.7 and 3.5+, mostly where str vs bytes and
UTF-8 encoding/decoding are concerned. This can be cleaned up
significantly once support for 2.7 is finally dropped.

Be more thorough about file copyrights

Add a copyright header to the .gitignore file with start and end
years determined from its commit history. Add copyright headers for
the current year to overrides.log and qa.log, and also add
functionality to correlate() which adds these headers from now on.
Update the copyright year on overrides.conf, which was missed in
8a37edd and later commits. All files tracked in this repository now
declare a copyright and refer to the main LICENSE file for licensing
terms.

Don't use "is" with a literal to test for equality

Solve a SyntaxWarning under Python 3.8 and later for use of the "is"
identity operator when comparing literals, by replacing with the
"==" equality operator.

Caching support for URLs with port numbers

When mangling URLs of fetched data to store in the local cache, only
split on the first colon so that URLs with port numbers in them are
properly differentiated. Previously, all URLs for the same domain
name landed in a single file if a port number was included, causing
incorrect results to be returned from the cache.

Use a dedicated field for cached search timestamps

Fix a cache corruption issue by using a new "cached" field to hold
the timestamp for cached correlation search results. Previously the
"description" field was being overloaded, but this could cause the
cache to no longer load because of duplicate fields.

Decode retrieved files as UTF-8 even on Python 2

Python 2.7 is likely the only Python 2 anyone is using any longer
(even that's well past EOL upstream now), and reasonably recent
versions of 2.7 it need the same decode hack as Python 3 anyway when
dealing with some retrieved content. Just get rid of the version
detection and do it under any version.

Add weather zone hkz000 for Hong Kong Observatory

Thanks to Bill Agee for suggesting the Hong Kong Observatory's
weather forecast page. A custom filter is implemented to strip the
forecast text from the HTML page in which it is embedded (if anyone
finds a plaintext version published at an alternate URL, let me know
and I'll rip out the extra routine).

Add some fresh overrides

Override a number of active weather stations where searches of
various online sites return names and locations for them which are
not provided by the included sources.

Update correlation sources

Remove the stale metar.tbl and zonecatalog.curr.tar, which the USA
NWS hasn't been updating for many years, and add the public domain
airports.csv file from the amazing ourairports.com community. Also
update to latest (2019) USA Census Bureau location data, March 2020
WX zone information, cooperative sites list from 2018 (latest), and
regenerated active station and zone lists. Loss of the zonecatalog
necessitates directly applying various forecast and alert URL
patterns, though some which appeared unused by NWS for many years
were not included.

Clear out all old overrides, since the vast majority are obsoleted
by refreshed data, and build fresh correlation sets from the above
sources. Basically all sites have switched from HTTP to HTTPS, so
update URLs for this too.

Add FAQ entry about --headers values

Be as clear as possible about what the --headers command-line option
or headers configuration option does, and what sorts of values are
valid for it.

Fix Py3K compatibility for compressed correlation

When run under Python 3.x, explicitly decode decompressed
bytestreams if reading pre-compressed correlation data files.

Update release notes and docs for 2.3 release

Correct NOAA WX weather product URL regression

One piecemeal use of the retired weather.noaa.gov/pub URL was missed
in the correlate() function, causing it to be reintroduced for
zone-based reports (such as forecasts) in a subsequent correlation
dataset update. Correct the invalid URLs in the zones file, and
update the correlation routine to embed the correct and working
tgftp.nws.noaa.gov hostname instead.

Update release notes and docs for 2.2 release

Correlation set update

* overrides.conf: Latest source data corrections from
script-assisted research.

These remaining files are generated data. Normally they're not
something I feel good about committing into version control, but in
this case it allows for logging and tracking deltas in the data over
time...

* airports: Removed 18 airports corresponding to nonexistent
stations.

* stations: Removed 326 stations with no recent conditions, added
429.

* zones: Removed 45 zones with no recent forecasts, added 104.

* places, zctas: Based on latest Census Bureau data corrections,
updated with new correlations.

* overrides.log: Record of correlation set build.

* slist, zlist: State of active stations and weather zones at the
time of generation.

Update correlation logic for 2015 Gazetteer

Simple update to handle new filenames for the 2015 US Census Bureau
Gazetteer. Also update a comment which still had the old NWS station
list URL.

Correct setpath search order

Short-circuit the outer loop in setpath testing so that we stop
iterating through supplied path elements once a match is found.

Fix minor typo in NEWS file

There was an extra "and" in the first sentence of the 2.1 release
prose.

Update release notes and docs for 2.1 release

Update NOAA WX weather products URLs

Per http://www.wxforum.net/index.php?topic=29502.0 the old
http://weather.noaa.gov/pub site was deprecated and as of August 23
is no longer in service. Update the software and current dataset to
use working http://tgftp.nws.noaa.gov URLs instead.

Correlation set update

* overrides.conf: Latest source data corrections from
script-assisted research.

These remaining files are generated data. Normally they're not
something I feel good about committing into version control, but in
this case it allows for logging and tracking deltas in the data over
time...

* airports: Removed 527 airports corresponding to nonexistent
stations.

* stations: Removed 176 stations with no recent conditions, added
196.

* zones: Removed 5 zones with no recent forecasts.

* places, zctas: Based on latest Census Bureau data corrections,
updated with new correlations.

* overrides.log: Record of correlation set build.

* slist, zlist: State of active stations and weather zones at the
time of generation.

Support more recent data sources

Add support for 2014 Census Bureau data and the newer version of the
NWS COOP stations file.

Document correlation set rebuilding process

* INSTALL: Add a new section documenting the way in which newer
correlation data sets can be rebuilt and substituted for officially
distributed copies.

Correlation set update

* overrides.conf: Latest source data corrections from
script-assisted research.

These remaining files are generated data. Normally they're not
something I feel good about committing into version control, but in
this case it allows for logging and tracking deltas in the data over
time...

* airports: Removed 42 airports corresponding to nonexistent
stations, added 8.

* stations: Removed 303 stations with no recent conditions, added
403.

* zones: Removed 15 zones with no recent forecasts, added 13.

* places, zctas: Based on latest Census Bureau data corrections,
updated with new correlations.

* overrides.log: Record of correlation set build.

* slist, zlist: State of active stations and weather zones at the
time of generation.

Correlation building fixes

* weather.py(correlate): Note the updated URL to Census Bureau data
in file comments, and make the County-Public Forecast Zones
Correlation File parsing more robust against errors in the file
formatting.

Add a .gitignore file.

* .gitignore: This is merely for convenience, so that trashfiles from
testing or datafile rebuilds don't make it into the repository.

Update data files for rounding adjustment.

* airports, places, stations, zctas, zones: Regenerated from the same
base dataset used in 2.0, but this time with weather.py's updated
correlate function which rounds radian floats to 7 decimal places. No
nodes were added or removed, and the only changes were to take their
coordinate and distance values from sub-nanometer 10^-16 precision to
sub-meter 10^-7, which is still generally at least an order of magnitude
smaller than the base data precision anyway. This should almost entirely
solve any rounding error fuzz in subsequent data file updates.

Normalize data override configuration.

* overrides.conf: The data override configuration is now grouped and
alphabetized, so that it can have future updates more easily integrated.
No entries are added or removed in this change.

Rework data override configuration comments.

* overrides.conf: The data override configuration got very large and
unwieldy. In an effort to be able to normalize the content
programmatically, code comments have been replaced by comment
configuration options for each section.

Truncate radian floats in data files.

* weather.py(correlate): The radian values in data files have a tendency
to vary by the tiniest rounding errors from one Python release to
another. By truncating them to the 7th decimal place, which is still
sub-meter resolution, this problem is minimized and the resulting data
diffs become far less noisy.

Update sys.path example in INSTALL.

* INSTALL: The example for checking sys.path was syntactically invalid
for Python 3.x, so it has been fixed to work there as well as relatively
modern 2.x (tested with 2.5 since that's the oldest I had on hand).

Make sure data files have final newlines.

* weather.py(correlate): Previously the airports, places, stations,
zctas and zones files lacked trailing newlines, so this trivial patch
adds them before each is closed for writing.

2010 Census U.S. Gazetteer file layout changed.

* weather.py(correlate): The United States Census Bureau altered the
format of their 2010 Gazetteer on August 22, 2012, adding and reordering
a few fields. The previous version of the parser assumed a fixed field
order and ceased to work with the updated data files, so now the order
is inferred from the column headings in the first line of each file
instead.

Add /etc/weather/weatherrc to config search.

* weather.1(INPUT FILES): Updated the list of potential weatherrc
locations to reflect those mentioned in the INSTALL file, particularly
the addition of /etc/weather/weatherrc in the 2.0 release.

* weather.py(get_config): Adjusted the configuration search locations to
include /etc/weather/weatherrc, since the INSTALL file started
mentioning it in the 2.0 release even though it wasn't actually
implemented as pointed out by Ben Kohler.

Make --quiet quieter again.

* weather.py(Selections, guess): The the search cache notification
doesn't belong in terse output, as pointed out by Eric Cooper.

Imported from archive.

* Release 2.0: Heavy rewrite with too many new features to enumerate
here in the ChangeLog file.

* NEWS: List of important changes since 1.x releases.

* weather, weather.py: Implemented support for Python 3000 as
requested by ptchinster on behalf of Arch Linux, conditions/forecast
searches by latitude/longitude requested by Brandt Daniels, support
for newer NOAA forecasts pointed out by Darryl Mouck and Richard
Dooling, custom URIs requested by Michel Pelzer, international
weather stations requested by Milton Hubsher, and fixed a metric
conversion issue with negative values reported by Jochen Keil,
Michiel Appelman and Stefan Metzlaff. Thanks to everyone for your
input and assistance!

Imported from archive.

* Release 1.5.

* (all): Updated copyright notices for 2010.

* FAQ, INSTALL, LICENSE, README: Reformatted as ReStructuredText.

* FAQ: Updated to mention alternative sources for NOAA's stations
list, in case the recommended one is unavailable (thanks Celejar!).

* NEWS: Renamed to ChangeLog and refactored into GNU format.

* weather: Added some comment padding between the shebang line and
the copyright, so that distributions wishing to carry patches which
modify the interpreter path don't have to refresh them every year
when the copyright line changes in their context.

* weather, weather.1, weatherrc.5, weather.py: Added experimental
alert, atypes, aurl and zones options to support retrieval,
filtering and formatting of unexpired NWS severe weather advisories.

* weather.1, weatherrc.5: Minor cosmetic fixes to option
descriptions.

* weather.1, weatherrc.5, weather.py: Added imperial and metric
options to filter/convert display units (thanks to Andrew Carter for
this suggestion!).

* weather.py: Fixed a METAR parsing error which would trigger an
IndexError exception if the NWS didn't have a station description on
file (thanks to Celejar for reporting the bug!). Fixed METAR title
line parsing to look for human-readable city and state in the first
line--previous code stopped showing the city name after NWS made
slight format mods. Upped the version to 1.5.

* weatherrc: Additional PIE (Saint Petersburg, FL), PNC (Ponca City,
OK), and PNS (Pensacola, FL) aliases.

Imported from archive.

* Release 1.4.

* (all): Updated the copyright years for 2008 on some of the files
in the current release and added a copyright statement to any files
previously lacking one.

* LICENSE: Replaced the previous BSD-like license with the one used
by the OpenBSD project (modeled after the Internet Software
Consortium's, a two-clause BSD license removing language made
unnecessary by the Berne convention); this new license is
functionally identical to the old one, just more terse and openly
recognized.

* weather: Clarified function parameters in calls from the wrapper
script to ease future ABI changes in the underlying module.

* weather, weather.py: Some extra comments were added to the source,
indentation style was updated from tab characters to three-space,
and lines longer than 79 columns were refactored or otherwise split.

* weather.1, weather.5, weather.py: Added an flines option to allow
the maximum number of forecast output lines to be shortened. Added
furl and murl options to allow overriding of the default current
conditions and forecast data retrieval URLs. Added a headers option
to allow overriding the default list of header names for current
conditions data filtering. Added a quiet option to suppress the
preamble lines and indentation for both current conditions and
forecast output.

* weather.py: Replaced the hardcoded fallback default METAR station
ID and forecast city/state abbreviation with error messages to
minimize confusion when necessary values are omitted. Adjusted a
couple of hard-coded error message strings to be consistent with the
output format of the option_parser module. Switched from urllib to
urllib2 for retrieving data, providing a simpler means to detect and
report retrieval errors. Upped the version to 1.4.

Imported from archive.

* Release 1.3.

* FAQ: Update to clarify that specifying an id won't automatically
provide a city and st to get the accompanying forecast.

* weather: Provided a consistent means for relocating weather.py to
a private location; thanks to Mark Tran for pointing out a conflict
with pyweather in ArchLinux (and presumably other distros as well).

* weather.py: Upped the version to 1.3.

Imported from archive.

* Release 1.2.

* FAQ, README: Updated for inclsuion of weather-util in Debian.

* weather.py: Upped the version to 1.2.

* weatherrc: Added more default aliases PAO and SJC (requested by
Russ Allbery).

Imported from archive.

* Release 1.1.

* weather: Switched to "#!/usr/bin/env python" instead for
portability.

* weather.1, weather.5, weather.py: Implemented the --omit-forecast
option to cancel --forecast.

* weather.py: Calling with undefined aliases now throws an error and
exits. Aliases, options and default overrides operate more
logically. Upped the version to 1.1.

* weatherrc: Added 214 standard aliases.

Imported from archive.

* Initial release 1.0.