tools.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. #============================================================================
  2. # This file is part of Pwman3.
  3. #
  4. # Pwman3 is free software; you can redistribute it and/or modify
  5. # it under the terms of the GNU General Public License, version 2
  6. # as published by the Free Software Foundation;
  7. #
  8. # Pwman3 is distributed in the hope that it will be useful,
  9. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. # GNU General Public License for more details.
  12. #
  13. # You should have received a copy of the GNU General Public License
  14. # along with Pwman3; if not, write to the Free Software
  15. # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  16. #============================================================================
  17. # Copyright (C) 2013 Oz Nahum <nahumoz@gmail.com>
  18. #============================================================================
  19. """
  20. Define the CLI interface for pwman3 and the helper functions
  21. """
  22. from __future__ import print_function
  23. from pwman.util.callback import Callback
  24. import pwman.util.config as config
  25. import subprocess as sp
  26. import getpass
  27. import sys
  28. import struct
  29. import os
  30. import colorama
  31. from pwman.data.tags import TagNew as Tag
  32. import pwman.util.generator as generator
  33. if sys.platform != 'win32':
  34. import termios
  35. import fcntl
  36. import tty
  37. try:
  38. import pyreadline as readline
  39. _readline_available = True
  40. except ImportError:
  41. _readline_available = False
  42. # raise ImportError("You need 'pyreadline' on Windows")
  43. else:
  44. try:
  45. import readline
  46. _readline_available = True
  47. except ImportError, e:
  48. _readline_available = False
  49. _defaultwidth = 10
  50. class ANSI(object):
  51. """
  52. ANSI Colors
  53. """
  54. Reset = 0
  55. Bold = 1
  56. Underscore = 2
  57. Black = 30
  58. Red = 31
  59. Green = 32
  60. Yellow = 33
  61. Blue = 34
  62. Magenta = 35
  63. Cyan = 36
  64. White = 37
  65. def typeset(text, color, bold=False, underline=False):
  66. """
  67. print colored strings using colorama
  68. """
  69. if not config.get_value("Global", "colors") == 'yes':
  70. return text
  71. if bold:
  72. text = colorama.Style.BRIGHT + text
  73. if underline and not 'win32' in sys.platform:
  74. text = ANSI.Underscore + text
  75. return color + text + colorama.Style.RESET_ALL
  76. def select(question, possible):
  77. """
  78. select input from user
  79. """
  80. for i in range(0, len(possible)):
  81. print ("%d - %-" + str(_defaultwidth) + "s") % (i + 1, possible[i])
  82. while 1:
  83. uinput = getonechar(question)
  84. if uinput.isdigit() and int(uinput) in range(1, len(possible) + 1):
  85. return possible[int(uinput) - 1]
  86. def text_to_clipboards(text):
  87. """
  88. copy text to clipboard
  89. credit:
  90. https://pythonadventures.wordpress.com/tag/xclip/
  91. """
  92. # "primary":
  93. try:
  94. xsel_proc = sp.Popen(['xsel', '-pi'], stdin=sp.PIPE)
  95. xsel_proc.communicate(text)
  96. # "clipboard":
  97. xsel_proc = sp.Popen(['xsel', '-bi'], stdin=sp.PIPE)
  98. xsel_proc.communicate(text)
  99. except OSError, e:
  100. print (e, "\nExecuting xsel failed, is it installed ?\n \
  101. please check your configuration file ... ")
  102. def text_to_mcclipboard(text):
  103. """
  104. copy text to mac os x clip board
  105. credit:
  106. https://pythonadventures.wordpress.com/tag/xclip/
  107. """
  108. # "primary":
  109. try:
  110. pbcopy_proc = sp.Popen(['pbcopy'], stdin=sp.PIPE)
  111. pbcopy_proc.communicate(text)
  112. except OSError, e:
  113. print (e, "\nExecuting pbcoy failed...")
  114. def open_url(link, macosx=False):
  115. """
  116. launch xdg-open or open in MacOSX with url
  117. """
  118. uopen = "xdg-open"
  119. if macosx:
  120. uopen = "open"
  121. try:
  122. sp.Popen([uopen, link], stdin=sp.PIPE)
  123. except OSError, e:
  124. print ("Executing open_url failed with:\n", e)
  125. def getpassword(question, argsgiven=None,
  126. width=_defaultwidth, echo=False,
  127. reader=getpass.getpass, numerics=False, leetify=False,
  128. symbols=False, special_signs=False, length=None):
  129. # TODO: getpassword should recieve a config insatce
  130. # and generate the policy according to it,
  131. # so that getpassword in cli would be simplified
  132. if argsgiven == 1 or length:
  133. while not length:
  134. try:
  135. length = getinput("Password length (default 7): ", default='7')
  136. length = int(length)
  137. except ValueError:
  138. print("please enter a proper integer")
  139. password, dumpme = generator.generate_password(length, length,
  140. True, leetify,
  141. numerics,
  142. special_signs)
  143. print ("New password: %s" % (password))
  144. return password
  145. # no args given
  146. while True:
  147. a1 = reader(question.ljust(width))
  148. if not a1:
  149. return getpassword('', argsgiven=1)
  150. a2 = reader("[Repeat] %s" % (question.ljust(width)))
  151. if a1 == a2:
  152. return a1
  153. else:
  154. print ("Passwords don't match. Try again.")
  155. def gettermsize():
  156. s = struct.pack("HHHH", 0, 0, 0, 0)
  157. f = sys.stdout.fileno()
  158. x = fcntl.ioctl(f, termios.TIOCGWINSZ, s)
  159. rows, cols, width, height = struct.unpack("HHHH", x)
  160. return rows, cols
  161. def getinput(question, default="", reader=raw_input,
  162. completer=None, width=_defaultwidth):
  163. """
  164. http://stackoverflow.com/questions/2617057/\
  165. supply-inputs-to-python-unittests
  166. """
  167. if reader == raw_input:
  168. if not _readline_available:
  169. val = raw_input(question.ljust(width))
  170. if val:
  171. return val
  172. else:
  173. return default
  174. else:
  175. def defaulter():
  176. """define default behavior startup"""
  177. if _readline_available:
  178. readline.insert_text(default)
  179. readline.set_startup_hook(defaulter)
  180. readline.get_completer()
  181. readline.set_completer(completer)
  182. x = raw_input(question.ljust(width))
  183. readline.set_completer(completer)
  184. readline.set_startup_hook()
  185. return x
  186. else:
  187. return reader()
  188. def getyesno(question, defaultyes=False, width=_defaultwidth):
  189. if (defaultyes):
  190. default = "[Y/n]"
  191. else:
  192. default = "[y/N]"
  193. ch = getonechar("%s %s" % (question, default), width)
  194. if (ch == '\n'):
  195. if (defaultyes):
  196. return True
  197. else:
  198. return False
  199. elif (ch == 'y' or ch == 'Y'):
  200. return True
  201. elif (ch == 'n' or ch == 'N'):
  202. return False
  203. else:
  204. return getyesno(question, defaultyes, width)
  205. class CliMenu(object):
  206. def __init__(self):
  207. self.items = []
  208. def add(self, item):
  209. if (isinstance(item, CliMenuItem)):
  210. self.items.append(item)
  211. else:
  212. print (item.__class__)
  213. def run(self):
  214. while True:
  215. i = 0
  216. for x in self.items:
  217. i = i + 1
  218. # don't break compatability with old db
  219. try:
  220. current = x.getter()
  221. except TypeError:
  222. current = x.getter
  223. currentstr = ''
  224. if type(current) == list:
  225. for c in current:
  226. currentstr += ("%s " % (c))
  227. else:
  228. currentstr = current
  229. print ("%d - %-" + str(_defaultwidth)
  230. + "s %s") % (i, x.name + ":",
  231. currentstr)
  232. print ("%c - Finish editing" % ('X'))
  233. option = getonechar("Enter your choice:")
  234. try:
  235. print ("selection, ", option)
  236. # substract 1 because array subscripts start at 0
  237. selection = int(option) - 1
  238. # new value is created by calling the editor with the
  239. # previous value as a parameter
  240. # TODO: enable overriding password policy as if new node
  241. # is created.
  242. if selection == 1: # for password
  243. value = self.items[selection].editor(0)
  244. else:
  245. try:
  246. edit = self.items[selection].getter()
  247. value = self.items[selection].editor(edit)
  248. self.items[selection].setter(value)
  249. except TypeError:
  250. edit = self.items[selection].getter
  251. value = self.items[selection].editor(edit)
  252. self.items[selection].setter = value
  253. except (ValueError, IndexError):
  254. if (option.upper() == 'X'):
  255. break
  256. print ("Invalid selection")
  257. class CMDLoop(CliMenu):
  258. """
  259. Override CliMenu. This class is only used
  260. when editing NewNode,
  261. """
  262. def run(self, new_node=None):
  263. while True:
  264. i = 0
  265. for x in self.items:
  266. i = i + 1
  267. try:
  268. current = x.getter
  269. except AttributeError:
  270. current = x
  271. # when printing tags, we have list ...
  272. currentstr = ''
  273. if type(current) == list:
  274. for c in current:
  275. try:
  276. currentstr += ' ' + c
  277. except TypeError:
  278. currentstr += ' ' + c.name
  279. # for the case we are not dealing with
  280. # a list of tags
  281. else:
  282. currentstr = current
  283. print ("%s - %s: %s" % (i, x.name, currentstr))
  284. print("X - Finish editing")
  285. option = getonechar("Enter your choice:")
  286. try:
  287. print ("Selection, ", option)
  288. # substract 1 because array subscripts start at 0
  289. selection = int(option) - 1
  290. # new value is created by calling the editor with the
  291. # previous value as a parameter
  292. # TODO: enable overriding password policy as if new node
  293. # is created.
  294. if selection == 0:
  295. new_node.username = getinput("Username:")
  296. self.items[0].getter = new_node.username
  297. self.items[0].setter = new_node.username
  298. elif selection == 1: # for password
  299. new_node.password = getpassword('New Password:')
  300. self.items[1].getter = new_node.password
  301. self.items[1].setter = new_node.password
  302. elif selection == 2:
  303. new_node.url = getinput("Url:")
  304. self.items[2].getter = new_node.url
  305. self.items[2].setter = new_node.url
  306. elif selection == 3: # for notes
  307. new_node.notes = getinput("Notes:")
  308. self.items[3].getter = new_node.notes
  309. self.items[3].setter = new_node.notes
  310. elif selection == 4:
  311. taglist = getinput("Tags:")
  312. tagstrings = taglist.split()
  313. tags = [Tag(tn) for tn in tagstrings]
  314. new_node.tags = tags
  315. self.items[4].setter = new_node.tags
  316. self.items[4].getter = new_node.tags
  317. except (ValueError, IndexError):
  318. if (option.upper() == 'X'):
  319. break
  320. print("Invalid selection")
  321. def getonechar(question, width=_defaultwidth):
  322. question = "%s " % (question)
  323. print (question.ljust(width),)
  324. sys.stdout.flush()
  325. fd = sys.stdin.fileno()
  326. # tty module exists only if we are on Posix
  327. try:
  328. tty_mode = tty.tcgetattr(fd)
  329. tty.setcbreak(fd)
  330. except NameError:
  331. pass
  332. try:
  333. ch = os.read(fd, 1)
  334. finally:
  335. try:
  336. tty.tcsetattr(fd, tty.TCSAFLUSH, tty_mode)
  337. except NameError:
  338. pass
  339. print(ch)
  340. return ch
  341. class CliMenuItem(object):
  342. def __init__(self, name, editor, getter, setter):
  343. self.name = name
  344. self.editor = editor
  345. self.getter = getter
  346. self.setter = setter
  347. class CLICallback(Callback):
  348. def getinput(self, question):
  349. return raw_input(question)
  350. def getsecret(self, question):
  351. return getpass.getpass(question + ":")