/usr/share/pyshared/advancedcaching/cli.py is in agtl 0.8.0.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 | #!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (C) 2010 Daniel Fett
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Author: Daniel Fett agtl@danielfett.de
# Jabber: fett.daniel@jaber.ccc.de
# Bugtracker and GIT Repository: http://github.com/webhamster/advancedcaching
#
import geocaching
import sys
import geo
import math
import os
usage = r'''Here's how to use this app:
If you want to use the gui:
%(name)s --simple
Simple User Interface, for mobile devices such as the Openmoko Freerunner
%(name)s --desktop
Full User Interface, for desktop usage (not implemented yet)
If you don't like your mouse:
%(name)s set [options]
Change the configuration.
%(name)s import [importactions]
Fetch geocaches from geocaching.com and write to the internal database.
%(name)s import [importactions] do [actions]
Fetch geocaches from geocaching.com, put them into the internal database and do whatever actions are listed.
%(name)s filter [filter-options] do [actions]
Query the internal database for geocaches and do the desired actions.
%(name)s import [importactions] filter [filter-options] do [actions]
Import geocaches, put them into the internal database, filter the imported geocaches and run the actions.
%(name)s sql "SELECT * FROM geocaches WHERE ... ORDER BY ... LIMIT ..." do [actions]
Select geocaches from local database and run the actions afterwards. Additional use of the filter is also supported. To get more information, run "%(name)s sql".
options:
--user(name) username
--pass(word) password
Your geocaching.com login data.
importactions:
--in coord1 coord2
Fetches the index of geocaches between the given coordinates.
These are interpreted as the corners of a rectangle. All caches
within the rectangle are retrieved. No details are retrieved.
--around coord radius-in-km
Fetches the index of geocaches at the given coordinate and radius
kilometers around it. No details are retrieved.
--at-route coord1 coord2 radius-in-km
Find caches along the route from coord1 to coord2. Uses OpenRouteService
and is not available for routes outside of europe.
filter-options:
--in coord1 coord2
--around coord1 radius-in-km
See import actions.
-f|--found
-F|--not-found
Filter out geocaches which have (not) been found by the user.
-w|--was-downloaded
caches which have full detail information available
-s|--size (min|max) 1..4|micro|small|regular|huge|other
Specify a minimum or maximum size. If min/max is not given, show
only geocaches with the given size.
-d|--difficulty (min|max) 1.0..5.0
-t|--terrain (min|max) 1.0..5.0
Filter out geocaches by difficulty or terrain.
-T|--type type,type,...
type: virtual|regular|unknown|multi|event
Only show geocaches of the given type(s)
-o|--owner owner-search-string
-n|--name name-search-string
-i|--id id-search-string
Search owner, name (title) or id of the geocaches.
--new
Caches which were downloaded in current session. Useful to
get alerted when new caches arrive.
actions:
--print
Default action, prints tab-separated list of geocaches
--fetch-details
Downloads Descriptions etc. for selected geocaches
--export-html folder
Dumps HTML pages to given folder
--command command
Runs command if more than one geocache has survived the filtering.
The placeholder %%s is replaced by a shell-escaped list of geocaches.
Not implemented yet:
--export-gpx folder
Dumps geocaches into separate GPX files
--export-single-gpx file
Dumps selected geocaches into a single GPX file
--draw-map zoom file
Draws one big JPEG file with the positions of the selected geocaches
--draw-maps zoom folder [tiles]
Draws a small JPEG image for every geocache.
Preferred format for coordinates:
'N49 44.111 E6 29.123'
or
'N49.123456 E6.043212'
Instead of a coordinate, you may also query geonames.com for a place name.
Just start the string with 'q:':
q:London
'q:Brisbane, Australia'
'''
class ParseError(Exception):
def __init__(self, errormsg, token = None):
self.msg = errormsg
self.token = token
def __str__(self):
return repr(self.msg)
class RunError(Exception):
def __init__(self, errormsg):
self.msg = errormsg
def __str__(self):
return repr(self.msg)
class Cli():
USES = ['geonames']
# operators
EQ = 0
MIN = 1
MAX = 2
def __init__(self, core, dataroot):
self.nt = 1
self.core = core
self.caches = None
self.new_caches = []
self.pointprovider = core.pointprovider
pass
def write_settings(self, settings):
self.settings = settings
def show(self):
print "$ The command line interface is not fully implemented yet, feel"
print "$ free to contribute at git://github.com/webhamster/advancedcaching.git"
try:
self.parse_input()
except ParseError, e:
if e.token == None:
print "# Parse Error at token '%s': " % sys.argv[self.nt - 1]
else:
print "# Parse Error after Token '%s':" % sys.argv[e.token]
print "# %s" % e.msg
except RunError, e:
print "# Execution Error at token '%s': " % sys.argv[self.nt - 1]
print "# %s" % e.msg
def check_caches_retrieved(self):
if self.caches == None:
self.caches = self.pointprovider.get_all()
print "* retrieved all caches (%d) from database" % len(self.caches)
def parse_input (self):
while self.has_next():
if sys.argv[self.nt] == 'set':
self.parse_set()
if sys.argv[self.nt] == 'import':
self.parse_import()
elif sys.argv[self.nt] == 'sql':
self.parse_sql()
elif sys.argv[self.nt] == 'filter':
self.parse_filter()
elif sys.argv[self.nt] == 'do':
self.parse_actions()
else:
raise ParseError("Expected 'import', 'sql', 'filter' or 'do'", self.nt - 1)
def parse_set(self):
self.nt += 1
if not self.has_next():
raise ParseError("Expected some options.")
while self.has_next():
token = sys.argv[self.nt]
self.nt += 1
if token == '--pass' or token == '--password':
password = self.parse_string()
self.set_password(password)
elif token == '--user' or token == '--username':
username = self.parse_string()
self.set_username(username)
else:
raise ParseError("I don't understand '%s'" % token)
print "* Finished setting options. Exiting."
sys.exit()
def parse_import(self):
self.nt += 1
if not self.has_next():
raise ParseError("Expected import actions.")
token = sys.argv[self.nt]
self.nt += 1
if token == '--in':
coord1 = self.parse_coord()
coord2 = self.parse_coord()
self.import_points(coord1, coord2)
elif token == '--around':
coord1 = self.parse_coord()
radius = self.parse_int()
self.import_points(coord1, radius)
elif token == '--at-route':
coord1 = self.parse_coord()
coord2 = self.parse_coord()
radius = self.parse_int()
self.import_points_route(coord1, coord2, radius)
else:
# undo what we did.
self.nt -= 1
return
def parse_sql(self):
self.nt += 1
if not self.has_next():
print "Table structure for geocaches:"
info = self.pointprovider.get_table_info()
for row in info:
print "\t".join([str(x) for x in row])
print "Example SQL-Query:"
print "SELECT * FROM geocaches WHERE type = 'multi' AND name LIKE 'GC1X%' AND found = 0 ORDER BY title DESC LIMIT 5"
raise ParseError("Expected sql string.")
text = self.parse_string()
self.caches = self.pointprovider.get_by_query(text)
def parse_filter(self):
self.check_caches_retrieved()
self.nt += 1
if not self.has_next():
raise ParseError("Expected filter options.")
while self.has_next():
token = sys.argv[self.nt]
self.nt += 1
if token == '--in':
coord1 = self.parse_coord()
coord2 = self.parse_coord()
self.add_filter_in(coord1, coord2)
elif token == '--around':
coord1 = self.parse_coord()
radius = self.parse_int()
self.add_filter_in(coord1, radius)
elif token == '--found' or token == '-f':
self.add_filter_found(True)
elif token == '--not-found' or token == '-F':
self.add_filter_found(False)
elif token == '-w' or token == '--was-downloaded':
self.add_filter_has_details(True)
elif token == '-s' or token == '--size':
op = self.parse_operator()
size = self.parse_size()
self.add_filter_size(op, size)
elif token == '-d' or token == '--difficulty':
op = self.parse_operator()
diff = self.parse_decimal()
self.add_filter_difficulty(op, diff)
elif token == '-t' or token == '--terrain':
op = self.parse_operator()
terr = self.parse_decimal()
self.add_filter_terrain(op, terr)
elif token == '-T' or token == '--type':
types = self.parse_types()
self.add_filter_types(types)
elif token == '-o' or token == '--owner':
owner = self.parse_string()
self.add_filter_owner(owner)
elif token == '-n' or token == '--name':
name = self.parse_string()
self.add_filter_name (name)
elif token == '-i' or token == '--id':
id = self.parse_string()
self.add_filter_id (id)
elif token == '--new':
self.caches = self.new_caches
else:
# undo what we did.
self.nt -= 1
return
def parse_actions(self):
self.check_caches_retrieved()
self.nt += 1
if not self.has_next():
raise ParseError("Expected actions.")
while self.has_next():
token = sys.argv[self.nt]
self.nt += 1
if token == '--print':
self.action_print()
elif token == '--fetch-details':
self.action_fetch_details()
elif token == '--export-html':
folder = self.parse_string()
self.action_export('html', folder)
elif token == '--export-gpx':
folder = self.parse_string()
self.action_export('gpx', folder)
elif token == '--export-single-gpx':
raise ParseError("Exporting to a single gpx file is currently not supported, sorry.")
filename = self.parse_string()
self.action_export_single_gpx(filename)
elif token == '--draw-map':
zoom = self.parse_integer()
filename = self.parse_string()
self.action_draw_map(zoom, filename)
elif token == '--draw-maps':
zoom = self.parse_integer()
folder = self.parse_string()
self.action_draw_maps(zoom, folder)
elif token == '--command':
cmd = self.parse_string()
self.action_command(cmd)
else:
raise ParseError("Unknown export action: %s" % token)
def has_next(self):
# if we have 5 tokens
# then 1..4 are valid tokens (0 is command)
# "5" is len(tokens)
# so we have a next token, if nt < len(tokens)-1
return (self.nt < len(sys.argv))
def parse_coord(self):
if not self.has_next():
raise ParseError("Expected Coordinate but there was none.", self.nt-1)
text = sys.argv[self.nt]
self.nt += 1
if text.startswith('q:'):
query = text[2:]
try:
c = self.core.get_coord_by_name(query)
except Exception, e:
raise ParseError(e)
else:
try:
c = geo.try_parse_coordinate(text)
except Exception, e:
raise ParseError(e)
return c
def parse_string(self):
if not self.has_next():
raise ParseError("Expected some Input, found nothing", self.nt-1)
text = sys.argv[self.nt]
self.nt += 1
return text.strip()
def parse_int(self):
if not self.has_next():
raise ParseError("Expected a number, found nothing.", self.nt-1)
text = sys.argv[self.nt]
self.nt += 1
return int(text)
def parse_size(self):
if not self.has_next():
raise ParseError("Expected a size (1..4/micro/small/regular/huge/other), found nothing.", self.nt-1)
text = sys.argv[self.nt].lower()
self.nt += 1
if text in ['1', '2', '3', '4', '5']:
return int(text)
elif text == 'micro':
return 1
elif text == 'small':
return 2
elif text in ['normal', 'regular']:
return 3
elif text in ['huge', 'big']:
return 4
elif text == 'other':
return 5
else:
raise ParseError('Unknown size: %s' % text)
def parse_types(self):
if not self.has_next():
raise ParseError("Expected geocache type, found not even an electronic sausage.", self.nt-1)
text = sys.argv[self.nt].lower()
self.nt += 1
types = text.split(',')
output = []
for i in types:
if i in geocaching.GeocacheCoordinate.TYPES:
output.append(i)
else:
raise ParseError("Unknown Type: %s (expected one of: %s)" % (i, ', '.join(geocaching.GeocacheCoordinate.TYPES)))
return output
def parse_operator(self):
text = sys.argv[self.nt]
if text == 'min':
self.nt += 1
return self.MIN
elif text == 'max':
self.nt += 1
return self.MAX
else:
return self.EQ
def parse_decimal(self):
if not self.has_next():
raise ParseError("Expected a number", self.nt - 1)
text = sys.argv[self.nt]
try:
return 10 * float(text)
except:
raise ParseError("Could not parse '%s' as a valid number." % text)
def set_username(self, string):
self.settings['options_username'] = string
self.core.on_config_changed(self.settings)
def set_password(self, string):
self.settings['options_password'] = string
self.core.on_config_changed(self.settings)
def import_points(self, c1, c2):
if isinstance(c2, geo.Coordinate):
print "* Downloading Caches between %s and %s" % (c1, c2)
self.caches, self.new_caches = self.core.on_download((c1, c2))
else:
# try to calculate some points northwest and southeast to the
# given point with approximately correct distances
new_c1 = c1.transform(-45, c2 * 1000 * math.sqrt(2))
new_c2 = c1.transform(-45 + 180, c2 * 1000 * math.sqrt(2))
print "* Downloading Caches in %d km distance to %s" % (c2, c1)
print "* Approximation: Caches between %s and %s" % (new_c1, new_c2)
self.caches, self.new_caches = self.core.on_download((new_c1, new_c2))
def import_points_route(self, c1, c2, r):
print "* Querying OpenRouteService for route from startpoint to endpoint"
points = self.core.get_route(c1, c2, r)
print "* Found route, now retrieving partial cache overviews"
for p in points:
self.import_points(p[0], p[1])
#pass
print "* Done."
def add_filter_in(self, coord1, coord2):
if isinstance(coord2, geo.Coordinate):
self.caches = filter(lambda x: self.filter_in(coord1, coord2, x), self.caches)
else:
self.caches = filter(lambda x: self.filter_in_radius(coord1, coord2, x), self.caches)
print "* filter in radius/coordinates: %d left" % len(self.caches)
def filter_in(self, c1, c2, check):
return (check.lat > min(c1.lat, c2.lat)
and check.lat < max(c1.lat, c2.lat)
and check.lon > min(c1.lon, c2.lon)
and check.lon < max(c1.lon, c2.lon))
def filter_in_radius(self, coord1, radius, check):
return check.distance_to(coord1) <= radius * 1000
def add_filter_found(self, found):
self.caches = filter(lambda x: x.found == found, self.caches)
print "* filter width found: %d left" % len(self.caches)
def add_filter_has_details(self, has_details):
self.caches = filter(lambda x: x.was_downloaded() == has_details, self.caches)
print "* filter with 'has details': %d left" % len(self.caches)
def add_filter_size(self, op, size):
if op == self.EQ:
self.caches = filter(lambda x: x.size == size, self.caches)
elif op == self.MIN:
self.caches = filter(lambda x: x.size >= size, self.caches)
elif op == self.MAX:
self.caches = filter(lambda x: x.size <= size, self.caches)
else:
raise RunError("What Happen? Somebody set us up the geocache.")
print "* filter with size: %d left" % len(self.caches)
def add_filter_difficulty(self, op, diff):
if op == self.EQ:
self.caches = filter(lambda x: x.diff == diff, self.caches)
elif op == self.MIN:
self.caches = filter(lambda x: x.diff >= diff, self.caches)
elif op == self.MAX:
self.caches = filter(lambda x: x.diff <= diff, self.caches)
else:
raise RunError("What Happen? Somebody set us up the geocache.")
print "* filter with difficulty: %d left" % len(self.caches)
def add_filter_terrain(self, op, terr):
if op == self.EQ:
self.caches = filter(lambda x: x.terr == terr, self.caches)
elif op == self.MIN:
self.caches = filter(lambda x: x.terr >= terr, self.caches)
elif op == self.MAX:
self.caches = filter(lambda x: x.terr <= terr, self.caches)
else:
raise RunError("What Happen? Somebody set us up the geocache.")
print "* filter with terrain: %d left" % len(self.caches)
def add_filter_types(self, types):
self.caches = filter(lambda x: x.type in types, self.caches)
print "* filter with types: %d left" % len(self.caches)
def add_filter_owner(self, owner):
self.caches = filter(lambda x: owner.lower() in x.owner.lower(), self.caches)
print "* filter with owner: %d left" % len(self.caches)
def add_filter_name (self, name):
self.caches = filter(lambda x: name.lower() in x.title.lower(), self.caches)
print "* filter with name: %d left" % len(self.caches)
def add_filter_id (self, idstring):
self.caches = filter(lambda x: idstring.lower() in x.name.lower(), self.caches)
print "* filter with id: %d left" % len(self.caches)
def action_print (self):
print "Found %d Caches:" % len(self.caches)
for c in self.caches:
print "%s\t%s (%s)" % (c.name, c.title, c.type)
def action_fetch_details(self):
i = 1
for c in self.caches:
print "* (%d of %d)\tDownloading '%s'" % (i, len(self.caches), c.title)
self.core.on_download_cache(c)
i += 1
def action_export(self, format, folder):
i = 1
for c in self.caches:
print "* (%d of %d)\tExporting to %s: '%s'" % (i, len(self.caches), format, c.title)
self.core.on_export_cache(c, format, folder)
i += 1
def action_command(self, commandline):
import unicodedata
if len(self.caches) == 0:
print "* Not running command (no geocaches left)"
return
list = " -- ".join(["%s (%s)" % (a.title, a.type) for a in self.caches])
if not isinstance(list, str):
list = unicodedata.normalize('NFKD', list).encode('ascii','ignore')
os.system(commandline % ('"%s"' % list.encode('string-escape')))
def set_download_progress(self, some, thing):
pass
def hide_progress(self):
pass
def show_error(self, message):
raise RunError(message)
|