<head>')\n self.wfile.write('<title>Denied: %s</title>' % e)\n self.wfile.write('</head><body>')\n self.wfile.write('auth=%s<p>' % auth)\n self.wfile.write('b64str=%s<p>' % b64str)\n self.wfile.write('username: %s<p>' % username)\n self.wfile.write('userpass: %s<p>' % userpass)\n self.wfile.write('password: %s<p>' % password)\n self.wfile.write('You sent:<br>%s<p>' % self.headers)\n self.wfile.write('</body></html>')\n return True\n\n # Authentication successful. (Return a cachable response to allow for\n # testing cached pages that require authentication.)\n old_protocol_version = self.protocol_version\n self.protocol_version = \"HTTP/1.1\"\n\n if_none_match = self.headers.getheader('if-none-match')\n if if_none_match == \"abc\":\n self.send_response(304)\n self.end_headers()\n elif url_path.endswith(\".gif\"):\n # Using chrome/test/data/google/logo.gif as the test image\n test_image_path = ['google', 'logo.gif']\n gif_path = os.path.join(self.server.data_dir, *test_image_path)\n if not os.path.isfile(gif_path):\n self.send_error(404)\n self.protocol_version = old_protocol_version\n return True\n\n f = open(gif_path, \"rb\")\n data = f.read()\n f.close()\n\n self.send_response(200)\n self.send_header('Content-Type', 'image/gif')\n self.send_header('Cache-control', 'max-age=60000')\n self.send_header('Etag', 'abc')\n self.end_headers()\n self.wfile.write(data)\n else:\n self.send_response(200)\n self.send_header('Content-Type', 'text/html')\n self.send_header('Cache-control', 'max-age=60000')\n self.send_header('Etag', 'abc')\n self.end_headers()\n self.wfile.write('<html><head>')\n self.wfile.write('<title>%s/%s</title>' % (username, password))\n self.wfile.write('</head><body>')\n self.wfile.write('auth=%s<p>' % auth)\n self.wfile.write('You sent:<br>%s<p>' % self.headers)\n self.wfile.write('</body></html>')\n\n self.protocol_version = old_protocol_version\n return True\n\n def GetNonce(self, force_reset=False):\n \"\"\"Returns a nonce that's stable per request path for the server's lifetime.\n This is a fake implementation. A real implementation would only use a given\n nonce a single time (hence the name n-once). However, for the purposes of\n unittesting, we don't care about the security of the nonce.\n\n Args:\n force_reset: Iff set, the nonce will be changed. Useful for testing the\n \"stale\" response.\n \"\"\"\n\n if force_reset or not self.server.nonce_time:\n self.server.nonce_time = time.time()\n return hashlib.md5('privatekey%s%d' %\n (self.path, self.server.nonce_time)).hexdigest()\n\n def AuthDigestHandler(self):\n \"\"\"This handler tests 'Digest' authentication.\n\n It just sends a page with title 'user/pass' if you succeed.\n\n A stale response is sent iff \"stale\" is present in the request path.\n \"\"\"\n\n if not self._ShouldHandleRequest(\"/auth-digest\"):\n return False\n\n stale = 'stale' in self.path\n nonce = self.GetNonce(force_reset=stale)\n opaque = hashlib.md5('opaque').hexdigest()\n password = 'secret'\n realm = 'testrealm'\n\n auth = self.headers.getheader('authorization')\n pairs = {}\n try:\n if not auth:\n raise Exception('no auth')\n if not auth.startswith('Digest'):\n raise Exception('not digest')\n # Pull out all the name=\"value\" pairs as a dictionary.\n pairs = dict(re.findall(r'(\\b[^ ,=]+)=\"?([^\",]+)\"?', auth))\n\n # Make sure it's all valid.\n if pairs['nonce'] != nonce:\n raise Exception('wrong nonce')\n if pairs['opaque'] != opaque:\n raise Exception('wrong opaque')\n\n # Check the 'response' value and make sure it matches our magic hash.\n # See http://www.ietf.org/rfc/rfc2617.txt\n hash_a1 = hashlib.md5(\n ':'.join([pairs['username'], realm, password])).hexdigest()\n hash_a2 = hashlib.md5(':'.join([self.command, pairs['uri']])).hexdigest()\n if 'qop' in pairs and 'nc' in pairs and 'cnonce' in pairs:\n response = hashlib.md5(':'.join([hash_a1, nonce, pairs['nc'],\n pairs['cnonce'], pairs['qop'], hash_a2])).hexdigest()\n else:\n response = hashlib.md5(':'.join([hash_a1, nonce, hash_a2])).hexdigest()\n\n if pairs['response'] != response:\n raise Exception('wrong password')\n except Exception, e:\n # Authentication failed.\n self.send_response(401)\n hdr = ('Digest '\n 'realm=\"%s\", '\n 'domain=\"/\", '\n 'qop=\"auth\", '\n 'algorithm=MD5, '\n 'nonce=\"%s\", '\n 'opaque=\"%s\"') % (realm, nonce, opaque)\n if stale:\n hdr += ', stale=\"TRUE\"'\n self.send_header('WWW-Authenticate', hdr)\n self.send_header('Content-Type', 'text/html')\n self.end_headers()\n self.wfile.write('<html><head>')\n self.wfile.write('<title>Denied: %s</title>' % e)\n self.wfile.write('</head><body>')\n self.wfile.write('auth=%s<p>' % auth)\n self.wfile.write('pairs=%s<p>' % pairs)\n self.wfile.write('You sent:<br>%s<p>' % self.headers)\n self.wfile.write('We are replying:<br>%s<p>' % hdr)\n self.wfile.write('</body></html>')\n return True\n\n # Authentication successful.\n self.send_response(200)\n self.send_header('Content-Type', 'text/html')\n self.end_headers()\n self.wfile.write('<html><head>')\n self.wfile.write('<title>%s/%s</title>' % (pairs['username'], password))\n self.wfile.write('</head><body>')\n self.wfile.write('auth=%s<p>' % auth)\n self.wfile.write('pairs=%s<p>' % pairs)\n self.wfile.write('</body></html>')\n\n return True\n\n def SlowServerHandler(self):\n \"\"\"Wait for the user suggested time before responding. The syntax is\n /slow?0.5 to wait for half a second.\"\"\"\n\n if not self._ShouldHandleRequest(\"/slow\"):\n return False\n query_char = self.path.find('?')\n wait_sec = 1.0\n if query_char >= 0:\n try:\n wait_sec = float(self.path[query_char + 1:])\n except ValueError:\n pass\n time.sleep(wait_sec)\n self.send_response(200)\n self.send_header('Content-Type', 'text/plain')\n self.end_headers()\n self.wfile.write(\"waited %.1f seconds\" % wait_sec)\n return True\n\n def ChunkedServerHandler(self):\n \"\"\"Send chunked response. Allows to specify chunks parameters:\n - waitBeforeHeaders - ms to wait before sending headers\n - waitBetweenChunks - ms to wait between chunks\n - chunkSize - size of each chunk in bytes\n - chunksNumber - number of chunks\n Example: /chunked?waitBeforeHeaders=1000&chunkSize=5&chunksNumber=5\n waits one second, then sends headers and five chunks five bytes each.\"\"\"\n\n if not self._ShouldHandleRequest(\"/chunked\"):\n return False\n query_char = self.path.find('?')\n chunkedSettings = {'waitBeforeHeaders' : 0,\n 'waitBetweenChunks' : 0,\n 'chunkSize' : 5,\n 'chunksNumber' : 5}\n if query_char >= 0:\n params = self.path[query_char + 1:].split('&')\n for param in params:\n keyValue = param.split('=')\n if len(keyValue) == 2:\n try:\n chunkedSettings[keyValue[0]] = int(keyValue[1])\n except ValueError:\n pass\n time.sleep(0.001 * chunkedSettings['waitBeforeHeaders'])\n self.protocol_version = 'HTTP/1.1' # Needed for chunked encoding\n self.send_response(200)\n self.send_header('Content-Type', 'text/plain')\n self.send_header('Connection', 'close')\n self.send_header('Transfer-Encoding', 'chunked')\n self.end_headers()\n # Chunked encoding: sending all chunks, then final zero-length chunk and\n # then final CRLF.\n for i in range(0, chunkedSettings['chunksNumber']):\n if i > 0:\n time.sleep(0.001 * chunkedSettings['waitBetweenChunks'])\n self.sendChunkHelp('*' * chunkedSettings['chunkSize'])\n self.wfile.flush() # Keep in mind that we start flushing only after 1kb.\n self.sendChunkHelp('')\n return True\n\n def NoContentHandler(self):\n \"\"\"Returns a 204 No Content response.\"\"\"\n\n if not self._ShouldHandleRequest(\"/nocontent\"):\n return False\n self.send_response(204)\n self.end_headers()\n return True\n\n def ServerRedirectHandler(self):\n \"\"\"Sends a server redirect to the given URL. The syntax is\n '/server-redirect?http://foo.bar/asdf' to redirect to\n 'http://foo.bar/asdf'\"\"\"\n\n test_name = \"/server-redirect\"\n if not self._ShouldHandleRequest(test_name):\n return False\n\n query_char = self.path.find('?')\n if query_char < 0 or len(self.path) <= query_char + 1:\n self.sendRedirectHelp(test_name)\n return True\n dest = urllib.unquote(self.path[query_char + 1:])\n\n self.send_response(301) # moved permanently\n self.send_header('Location', dest)\n self.send_header('Content-Type', 'text/html')\n self.end_headers()\n self.wfile.write('<html><head>')\n self.wfile.write('</head><body>Redirecting to %s</body></html>' % dest)\n\n return True\n\n def CrossSiteRedirectHandler(self):\n \"\"\"Sends a server redirect to the given site. The syntax is\n '/cross-site/hostname/...' to redirect to //hostname/...\n It is used to navigate between different Sites, causing\n cross-site/cross-process navigations in the browser.\"\"\"\n\n test_name = \"/cross-site\"\n if not self._ShouldHandleRequest(test_name):\n return False\n\n params = urllib.unquote(self.path[(len(test_name) + 1):])\n slash = params.find('/')\n if slash < 0:\n self.sendRedirectHelp(test_name)\n return True\n\n host = params[:slash]\n path = params[(slash+1):]\n dest = \"//%s:%s/%s\" % (host, str(self.server.server_port), path)\n\n self.send_response(301) # moved permanently\n self.send_header('Location', dest)\n self.send_header('Content-Type', 'text/html')\n self.end_headers()\n self.wfile.write('<html><head>')\n self.wfile.write('</head><body>Redirecting to %s</body></html>' % dest)\n\n return True\n\n def ClientRedirectHandler(self):\n \"\"\"Sends a client redirect to the given URL. The syntax is\n '/client-redirect?http://foo.bar/asdf' to redirect to\n 'http://foo.bar/asdf'\"\"\"\n\n test_name = \"/client-redirect\"\n if not self._ShouldHandleRequest(test_name):\n return False\n\n query_char = self.path.find('?')\n if query_char < 0 or len(self.path) <= query_char + 1:\n self.sendRedirectHelp(test_name)\n return True\n dest = urllib.unquote(self.path[query_char + 1:])\n\n self.send_response(200)\n self.send_header('Content-Type', 'text/html')\n self.end_headers()\n self.wfile.write('<html><head>')\n self.wfile.write('<meta http-equiv=\"refresh\" content=\"0;url=%s\">' % dest)\n self.wfile.write('</head><body>Redirecting to %s</body></html>' % dest)\n\n return True\n\n def GetSSLSessionCacheHandler(self):\n \"\"\"Send a reply containing a log of the session cache operations.\"\"\"\n\n if not self._ShouldHandleRequest('/ssl-session-cache'):\n return False\n\n self.send_response(200)\n self.send_header('Content-Type', 'text/plain')\n self.end_headers()\n try:\n log = self.server.session_cache.log\n except AttributeError:\n self.wfile.write('Pass --https-record-resume in order to use' +\n ' this request')\n return True\n\n for (action, sessionID) in log:\n self.wfile.write('%s\\t%s\\n' % (action, bytes(sessionID).encode('hex')))\n return True\n\n def SSLManySmallRecords(self):\n \"\"\"Sends a reply consisting of a variety of small writes. These will be\n translated into a series of small SSL records when used over an HTTPS\n server.\"\"\"\n\n if not self._ShouldHandleRequest('/ssl-many-small-records'):\n return False\n\n self.send_response(200)\n self.send_header('Content-Type', 'text/plain')\n self.end_headers()\n\n # Write ~26K of data, in 1350 byte chunks\n for i in xrange(20):\n self.wfile.write('*' * 1350)\n self.wfile.flush()\n return True\n\n def GetChannelID(self):\n \"\"\"Send a reply containing the hashed ChannelID that the client provided.\"\"\"\n\n if not self._ShouldHandleRequest('/channel-id'):\n return False\n\n self.send_response(200)\n self.send_header('Content-Type', 'text/plain')\n self.end_headers()\n channel_id = bytes(self.server.tlsConnection.channel_id)\n self.wfile.write(hashlib.sha256(channel_id).digest().encode('base64'))\n return True\n\n def ClientCipherListHandler(self):\n \"\"\"Send a reply containing the cipher suite list that the client\n provided. Each cipher suite value is serialized in decimal, followed by a\n newline.\"\"\"\n\n if not self._ShouldHandleRequest('/client-cipher-list'):\n return False\n\n self.send_response(200)\n self.send_header('Content-Type', 'text/plain')\n self.end_headers()\n\n cipher_suites = self.server.tlsConnection.clientHello.cipher_suites\n self.wfile.write('\\n'.join(str(c) for c in cipher_suites))\n return True\n\n def CloseSocketHandler(self):\n \"\"\"Closes the socket without sending anything.\"\"\"\n\n if not self._ShouldHandleRequest('/close-socket'):\n return False\n\n self.wfile.close()\n return True\n\n def RangeResetHandler(self):\n \"\"\"Send data broken up by connection resets every N (default 4K) bytes.\n Support range requests. If the data requested doesn't straddle a reset\n boundary, it will all be sent. Used for testing resuming downloads.\"\"\"\n\n def DataForRange(start, end):\n \"\"\"Data to be provided for a particular range of bytes.\"\"\"\n # Offset and scale to avoid too obvious (and hence potentially\n # collidable) data.\n return ''.join([chr(y % 256)\n for y in range(start * 2 + 15, end * 2 + 15, 2)])\n\n if not self._ShouldHandleRequest('/rangereset'):\n return False\n\n # HTTP/1.1 is required for ETag and range support.\n self.protocol_version = 'HTTP/1.1'\n _, _, url_path, _, query, _ = urlparse.urlparse(self.path)\n\n # Defaults\n size = 8000\n # Note that the rst is sent just before sending the rst_boundary byte.\n rst_boundary = 4000\n respond_to_range = True\n hold_for_signal = False\n rst_limit = -1\n token = 'DEFAULT'\n fail_precondition = 0\n send_verifiers = True\n\n # Parse the query\n qdict = urlparse.parse_qs(query, True)\n if 'size' in qdict:\n size = int(qdict['size'][0])\n if 'rst_boundary' in qdict:\n rst_boundary = int(qdict['rst_boundary'][0])\n if 'token' in qdict:\n # Identifying token for stateful tests.\n token = qdict['token'][0]\n if 'rst_limit' in qdict:\n # Max number of rsts for a given token.\n rst_limit = int(qdict['rst_limit'][0])\n if 'bounce_range' in qdict:\n respond_to_range = False\n if 'hold' in qdict:\n # Note that hold_for_signal will not work with null range requests;\n # see TODO below.\n hold_for_signal = True\n if 'no_verifiers' in qdict:\n send_verifiers = False\n if 'fail_precondition' in qdict:\n fail_precondition = int(qdict['fail_precondition'][0])\n\n # Record already set information, or set it.\n rst_limit = TestPageHandler.rst_limits.setdefault(token, rst_limit)\n if rst_limit != 0:\n TestPageHandler.rst_limits[token] -= 1\n fail_precondition = TestPageHandler.fail_precondition.setdefault(\n token, fail_precondition)\n if fail_precondition != 0:\n TestPageHandler.fail_precondition[token] -= 1\n\n first_byte = 0\n last_byte = size - 1\n\n # Does that define what we want to return, or do we need to apply\n # a range?\n range_response = False\n range_header = self.headers.getheader('range')\n if range_header and respond_to_range:\n mo = re.match(\"bytes=(\\d*)-(\\d*)\", range_header)\n if mo.group(1):\n first_byte = int(mo.group(1))\n if mo.group(2):\n last_byte = int(mo.group(2))\n if last_byte > size - 1:\n last_byte = size - 1\n range_response = True\n if last_byte < first_byte:\n return False\n\n if (fail_precondition and\n (self.headers.getheader('If-Modified-Since') or\n self.headers.getheader('If-Match'))):\n self.send_response(412)\n self.end_headers()\n return True\n\n if range_response:\n self.send_response(206)\n self.send_header('Content-Range',\n 'bytes %d-%d/%d' % (first_byte, last_byte, size))\n else:\n self.send_response(200)\n self.send_header('Content-Type', 'application/octet-stream')\n self.send_header('Content-Length', last_byte - first_byte + 1)\n if send_verifiers:\n # If fail_precondition is non-zero, then the ETag for each request will be\n # different.\n etag = \"%s%d\" % (token, fail_precondition)\n self.send_header('ETag', etag)\n self.send_header('Last-Modified', 'Tue, 19 Feb 2013 14:32 EST')\n self.end_headers()\n\n if hold_for_signal:\n # TODO(rdsmith/phajdan.jr): http://crbug.com/169519: Without writing\n # a single byte, the self.server.handle_request() below hangs\n # without processing new incoming requests.\n self.wfile.write(DataForRange(first_byte, first_byte + 1))\n first_byte = first_byte + 1\n # handle requests until one of them clears this flag.\n self.server.wait_for_download = True\n while self.server.wait_for_download:\n self.server.handle_request()\n\n possible_rst = ((first_byte / rst_boundary) + 1) * rst_boundary\n if possible_rst >= last_byte or rst_limit == 0:\n # No RST has been requested in this range, so we don't need to\n # do anything fancy; just write the data and let the python\n # infrastructure close the connection.\n self.wfile.write(DataForRange(first_byte, last_byte + 1))\n self.wfile.flush()\n return True\n\n # We're resetting the connection part way in; go to the RST\n # boundary and then send an RST.\n # Because socket semantics do not guarantee that all the data will be\n # sent when using the linger semantics to hard close a socket,\n # we send the data and then wait for our peer to release us\n # before sending the reset.\n data = DataForRange(first_byte, possible_rst)\n self.wfile.write(data)\n self.wfile.flush()\n self.server.wait_for_download = True\n while self.server.wait_for_download:\n self.server.handle_request()\n l_onoff = 1 # Linger is active.\n l_linger = 0 # Seconds to linger for.\n self.connection.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER,\n struct.pack('ii', l_onoff, l_linger))\n\n # Close all duplicates of the underlying socket to force the RST.\n self.wfile.close()\n self.rfile.close()\n self.connection.close()\n\n return True\n\n def DefaultResponseHandler(self):\n \"\"\"This is the catch-all response handler for requests that aren't handled\n by one of the special handlers above.\n Note that we specify the content-length as without it the https connection\n is not closed properly (and the browser keeps expecting data).\"\"\"\n\n contents = \"Default response given for path: \" + self.path\n self.send_response(200)\n self.send_header('Content-Type', 'text/html')\n self.send_header('Content-Length', len(contents))\n self.end_headers()\n if (self.command != 'HEAD'):\n self.wfile.write(contents)\n return True\n\n def RedirectConnectHandler(self):\n \"\"\"Sends a redirect to the CONNECT request for www.redirect.com. This\n response is not specified by the RFC, so the browser should not follow\n the redirect.\"\"\"\n\n if (self.path.find(\"www.redirect.com\") < 0):\n return False\n\n dest = \"http://www.destination.com/foo.js\"\n\n self.send_response(302) # moved temporarily\n self.send_header('Location', dest)\n self.send_header('Connection', 'close')\n self.end_headers()\n return True\n\n def ServerAuthConnectHandler(self):\n \"\"\"Sends a 401 to the CONNECT request for www.server-auth.com. This\n response doesn't make sense because the proxy server cannot request\n server authentication.\"\"\"\n\n if (self.path.find(\"www.server-auth.com\") < 0):\n return False\n\n challenge = 'Basic realm=\"WallyWorld\"'\n\n self.send_response(401) # unauthorized\n self.send_header('WWW-Authenticate', challenge)\n self.send_header('Connection', 'close')\n self.end_headers()\n return True\n\n def DefaultConnectResponseHandler(self):\n \"\"\"This is the catch-all response handler for CONNECT requests that aren't\n handled by one of the special handlers above. Real Web servers respond\n with 400 to CONNECT requests.\"\"\"\n\n contents = \"Your client has issued a malformed or illegal request.\"\n self.send_response(400) # bad request\n self.send_header('Content-Type', 'text/html')\n self.send_header('Content-Length', len(contents))\n self.end_headers()\n self.wfile.write(contents)\n return True\n\n # called by the redirect handling function when there is no parameter\n def sendRedirectHelp(self, redirect_name):\n self.send_response(200)\n self.send_header('Content-Type', 'text/html')\n self.end_headers()\n self.wfile.write('<html><body><h1>Error: no redirect destination</h1>')\n self.wfile.write('Use <pre>%s?http://dest...</pre>' % redirect_name)\n self.wfile.write('</body></html>')\n\n # called by chunked handling function\n def sendChunkHelp(self, chunk):\n # Each chunk consists of: chunk size (hex), CRLF, chunk body, CRLF\n self.wfile.write('%X\\r\\n' % len(chunk))\n self.wfile.write(chunk)\n self.wfile.write('\\r\\n')\n\n\nclass OCSPHandler(testserver_base.BasePageHandler):\n def __init__(self, request, client_address, socket_server):\n handlers = [self.OCSPResponse]\n self.ocsp_response = socket_server.ocsp_response\n testserver_base.BasePageHandler.__init__(self, request, client_address,\n socket_server, [], handlers, [],\n handlers, [])\n\n def OCSPResponse(self):\n self.send_response(200)\n self.send_header('Content-Type', 'application/ocsp-response')\n self.send_header('Content-Length', str(len(self.ocsp_response)))\n self.end_headers()\n\n self.wfile.write(self.ocsp_response)\n\n\nclass TCPEchoHandler(SocketServer.BaseRequestHandler):\n \"\"\"The RequestHandler class for TCP echo server.\n\n It is instantiated once per connection to the server, and overrides the\n handle() method to implement communication to the client.\n \"\"\"\n\n def handle(self):\n \"\"\"Handles the request from the client and constructs a response.\"\"\"\n\n data = self.request.recv(65536).strip()\n # Verify the \"echo request\" message received from the client. Send back\n # \"echo response\" message if \"echo request\" message is valid.\n try:\n return_data = echo_message.GetEchoResponseData(data)\n if not return_data:\n return\n except ValueError:\n return\n\n self.request.send(return_data)\n\n\nclass UDPEchoHandler(SocketServer.BaseRequestHandler):\n \"\"\"The RequestHandler class for UDP echo server.\n\n It is instantiated once per connection to the server, and overrides the\n handle() method to implement communication to the client.\n \"\"\"\n\n def handle(self):\n \"\"\"Handles the request from the client and constructs a response.\"\"\"\n\n data = self.request[0].strip()\n request_socket = self.request[1]\n # Verify the \"echo request\" message received from the client. Send back\n # \"echo response\" message if \"echo request\" message is valid.\n try:\n return_data = echo_message.GetEchoResponseData(data)\n if not return_data:\n return\n except ValueError:\n return\n request_socket.sendto(return_data, self.client_address)\n\n\nclass BasicAuthProxyRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):\n \"\"\"A request handler that behaves as a proxy server which requires\n basic authentication. Only CONNECT, GET and HEAD is supported for now.\n \"\"\"\n\n _AUTH_CREDENTIAL = 'Basic Zm9vOmJhcg==' # foo:bar\n\n def parse_request(self):\n \"\"\"Overrides parse_request to check credential.\"\"\"\n\n if not BaseHTTPServer.BaseHTTPRequestHandler.parse_request(self):\n return False\n\n auth = self.headers.getheader('Proxy-Authorization')\n if auth != self._AUTH_CREDENTIAL:\n self.send_response(407)\n self.send_header('Proxy-Authenticate', 'Basic realm=\"MyRealm1\"')\n self.end_headers()\n return False\n\n return True\n\n def _start_read_write(self, sock):\n sock.setblocking(0)\n self.request.setblocking(0)\n rlist = [self.request, sock]\n while True:\n ready_sockets, _unused, errors = select.select(rlist, [], [])\n if errors:\n self.send_response(500)\n self.end_headers()\n return\n for s in ready_sockets:\n received = s.recv(1024)\n if len(received) == 0:\n return\n if s == self.request:\n other = sock\n else:\n other = self.request\n other.send(received)\n\n def _do_common_method(self):\n url = urlparse.urlparse(self.path)\n port = url.port\n if not port:\n if url.scheme == 'http':\n port = 80\n elif url.scheme == 'https':\n port = 443\n if not url.hostname or not port:\n self.send_response(400)\n self.end_headers()\n return\n\n if len(url.path) == 0:\n path = '/'\n else:\n path = url.path\n if len(url.query) > 0:\n path = '%s?%s' % (url.path, url.query)\n\n sock = None\n try:\n sock = socket.create_connection((url.hostname, port))\n sock.send('%s %s %s\\r\\n' % (\n self.command, path, self.protocol_version))\n for header in self.headers.headers:\n header = header.strip()\n if (header.lower().startswith('connection') or\n header.lower().startswith('proxy')):\n continue\n sock.send('%s\\r\\n' % header)\n sock.send('\\r\\n')\n self._start_read_write(sock)\n except Exception:\n self.send_response(500)\n self.end_headers()\n finally:\n if sock is not None:\n sock.close()\n\n def do_CONNECT(self):\n try:\n pos = self.path.rfind(':')\n host = self.path[:pos]\n port = int(self.path[pos+1:])\n except Exception:\n self.send_response(400)\n self.end_headers()\n\n try:\n sock = socket.create_connection((host, port))\n self.send_response(200, 'Connection established')\n self.end_headers()\n self._start_read_write(sock)\n except Exception:\n self.send_response(500)\n self.end_headers()\n finally:\n sock.close()\n\n def do_GET(self):\n self._do_common_method()\n\n def do_HEAD(self):\n self._do_common_method()\n\n\nclass ServerRunner(testserver_base.TestServerRunner):\n \"\"\"TestServerRunner for the net test servers.\"\"\"\n\n def __init__(self):\n super(ServerRunner, self).__init__()\n self.__ocsp_server = None\n\n def __make_data_dir(self):\n if self.options.data_dir:\n if not os.path.isdir(self.options.data_dir):\n raise testserver_base.OptionError('specified data dir not found: ' +\n self.options.data_dir + ' exiting...')\n my_data_dir = self.options.data_dir\n else:\n # Create the default path to our data dir, relative to the exe dir.\n my_data_dir = os.path.join(BASE_DIR, \"..\", \"..\", \"..\", \"..\",\n \"test\", \"data\")\n\n #TODO(ibrar): Must use Find* funtion defined in google\\tools\n #i.e my_data_dir = FindUpward(my_data_dir, \"test\", \"data\")\n\n return my_data_dir\n\n def create_server(self, server_data):\n port = self.options.port\n host = self.options.host\n\n # Work around a bug in Mac OS 10.6. Spawning a WebSockets server\n # will result in a call to |getaddrinfo|, which fails with \"nodename\n # nor servname provided\" for localhost:0 on 10.6.\n if self.options.server_type == SERVER_WEBSOCKET and \\\n host == \"localhost\" and \\\n port == 0:\n host = \"127.0.0.1\"\n\n if self.options.server_type == SERVER_HTTP:\n if self.options.https:\n pem_cert_and_key = None\n ocsp_der = None\n if self.options.cert_and_key_file:\n if not os.path.isfile(self.options.cert_and_key_file):\n raise testserver_base.OptionError(\n 'specified server cert file not found: ' +\n self.options.cert_and_key_file + ' exiting...')\n pem_cert_and_key = file(self.options.cert_and_key_file, 'r').read()\n else:\n # generate a new certificate and run an OCSP server for it.\n self.__ocsp_server = OCSPServer((host, 0), OCSPHandler)\n print ('OCSP server started on %s:%d...' %\n (host, self.__ocsp_server.server_port))\n\n ocsp_state = None\n\n if self.options.ocsp == 'ok':\n ocsp_state = minica.OCSP_STATE_GOOD\n elif self.options.ocsp == 'revoked':\n ocsp_state = minica.OCSP_STATE_REVOKED\n elif self.options.ocsp == 'invalid':\n ocsp_state = minica.OCSP_STATE_INVALID\n elif self.options.ocsp == 'unauthorized':\n ocsp_state = minica.OCSP_STATE_UNAUTHORIZED\n elif self.options.ocsp == 'unknown':\n ocsp_state = minica.OCSP_STATE_UNKNOWN\n else:\n raise testserver_base.OptionError('unknown OCSP status: ' +\n self.options.ocsp_status)\n\n (pem_cert_and_key, ocsp_der) = minica.GenerateCertKeyAndOCSP(\n subject = \"127.0.0.1\",\n ocsp_url = (\"http://%s:%d/ocsp\" %\n (host, self.__ocsp_server.server_port)),\n ocsp_state = ocsp_state,\n serial = self.options.cert_serial)\n\n if self.options.ocsp_server_unavailable:\n # SEQUENCE containing ENUMERATED with value 3 (tryLater).\n self.__ocsp_server.ocsp_response = '30030a0103'.decode('hex')\n else:\n self.__ocsp_server.ocsp_response = ocsp_der\n\n for ca_cert in self.options.ssl_client_ca:\n if not os.path.isfile(ca_cert):\n raise testserver_base.OptionError(\n 'specified trusted client CA file not found: ' + ca_cert +\n ' exiting...')\n\n stapled_ocsp_response = None\n if self.options.staple_ocsp_response:\n stapled_ocsp_response = ocsp_der\n\n server = HTTPSServer((host, port), TestPageHandler, pem_cert_and_key,\n self.options.ssl_client_auth,\n self.options.ssl_client_ca,\n self.options.ssl_client_cert_type,\n self.options.ssl_bulk_cipher,\n self.options.ssl_key_exchange,\n self.options.enable_npn,\n self.options.record_resume,\n self.options.tls_intolerant,\n self.options.tls_intolerance_type,\n self.options.signed_cert_timestamps_tls_ext.decode(\n \"base64\"),\n self.options.fallback_scsv,\n stapled_ocsp_response,\n self.options.alert_after_handshake)\n print 'HTTPS server started on https://%s:%d...' % \\\n (host, server.server_port)\n else:\n server = HTTPServer((host, port), TestPageHandler)\n print 'HTTP server started on http://%s:%d...' % \\\n (host, server.server_port)\n\n server.data_dir = self.__make_data_dir()\n server.file_root_url = self.options.file_root_url\n server_data['port'] = server.server_port\n elif self.options.server_type == SERVER_WEBSOCKET:\n # Launch pywebsocket via WebSocketServer.\n logger = logging.getLogger()\n logger.addHandler(logging.StreamHandler())\n # TODO(toyoshim): Remove following os.chdir. Currently this operation\n # is required to work correctly. It should be fixed from pywebsocket side.\n os.chdir(self.__make_data_dir())\n websocket_options = WebSocketOptions(host, port, '.')\n scheme = \"ws\"\n if self.options.cert_and_key_file:\n scheme = \"wss\"\n websocket_options.use_tls = True\n websocket_options.private_key = self.options.cert_and_key_file\n websocket_options.certificate = self.options.cert_and_key_file\n if self.options.ssl_client_auth:\n websocket_options.tls_client_cert_optional = False\n websocket_options.tls_client_auth = True\n if len(self.options.ssl_client_ca) != 1:\n raise testserver_base.OptionError(\n 'one trusted client CA file should be specified')\n if not os.path.isfile(self.options.ssl_client_ca[0]):\n raise testserver_base.OptionError(\n 'specified trusted client CA file not found: ' +\n self.options.ssl_client_ca[0] + ' exiting...')\n websocket_options.tls_client_ca = self.options.ssl_client_ca[0]\n print 'Trying to start websocket server on %s://%s:%d...' % \\\n (scheme, websocket_options.server_host, websocket_options.port)\n server = WebSocketServer(websocket_options)\n print 'WebSocket server started on %s://%s:%d...' % \\\n (scheme, host, server.server_port)\n server_data['port'] = server.server_port\n websocket_options.use_basic_auth = self.options.ws_basic_auth\n elif self.options.server_type == SERVER_TCP_ECHO:\n # Used for generating the key (randomly) that encodes the \"echo request\"\n # message.\n random.seed()\n server = TCPEchoServer((host, port), TCPEchoHandler)\n print 'Echo TCP server started on port %d...' % server.server_port\n server_data['port'] = server.server_port\n elif self.options.server_type == SERVER_UDP_ECHO:\n # Used for generating the key (randomly) that encodes the \"echo request\"\n # message.\n random.seed()\n server = UDPEchoServer((host, port), UDPEchoHandler)\n print 'Echo UDP server started on port %d...' % server.server_port\n server_data['port'] = server.server_port\n elif self.options.server_type == SERVER_BASIC_AUTH_PROXY:\n server = HTTPServer((host, port), BasicAuthProxyRequestHandler)\n print 'BasicAuthProxy server started on port %d...' % server.server_port\n server_data['port'] = server.server_port\n elif self.options.server_type == SERVER_FTP:\n my_data_dir = self.__make_data_dir()\n\n # Instantiate a dummy authorizer for managing 'virtual' users\n authorizer = pyftpdlib.ftpserver.DummyAuthorizer()\n\n # Define a new user having full r/w permissions\n authorizer.add_user('chrome', 'chrome', my_data_dir, perm='elradfmw')\n\n # Define a read-only anonymous user unless disabled\n if not self.options.no_anonymous_ftp_user:\n authorizer.add_anonymous(my_data_dir)\n\n # Instantiate FTP handler class\n ftp_handler = pyftpdlib.ftpserver.FTPHandler\n ftp_handler.authorizer = authorizer\n\n # Define a customized banner (string returned when client connects)\n ftp_handler.banner = (\"pyftpdlib %s based ftpd ready.\" %\n pyftpdlib.ftpserver.__ver__)\n\n # Instantiate FTP server class and listen to address:port\n server = pyftpdlib.ftpserver.FTPServer((host, port), ftp_handler)\n server_data['port'] = server.socket.getsockname()[1]\n print 'FTP server started on port %d...' % server_data['port']\n else:\n raise testserver_base.OptionError('unknown server type' +\n self.options.server_type)\n\n return server\n\n def run_server(self):\n if self.__ocsp_server:\n self.__ocsp_server.serve_forever_on_thread()\n\n testserver_base.TestServerRunner.run_server(self)\n\n if self.__ocsp_server:\n self.__ocsp_server.stop_serving()\n\n def add_options(self):\n testserver_base.TestServerRunner.add_options(self)\n self.option_parser.add_option('-f', '--ftp', action='store_const',\n const=SERVER_FTP, default=SERVER_HTTP,\n dest='server_type',\n help='start up an FTP server.')\n self.option_parser.add_option('--tcp-echo', action='store_const',\n const=SERVER_TCP_ECHO, default=SERVER_HTTP,\n dest='server_type',\n help='start up a tcp echo server.')\n self.option_parser.add_option('--udp-echo', action='store_const',\n const=SERVER_UDP_ECHO, default=SERVER_HTTP,\n dest='server_type',\n help='start up a udp echo server.')\n self.option_parser.add_option('--basic-auth-proxy', action='store_const',\n const=SERVER_BASIC_AUTH_PROXY,\n default=SERVER_HTTP, dest='server_type',\n help='start up a proxy server which requires '\n 'basic authentication.')\n self.option_parser.add_option('--websocket', action='store_const',\n const=SERVER_WEBSOCKET, default=SERVER_HTTP,\n dest='server_type',\n help='start up a WebSocket server.')\n self.option_parser.add_option('--https', action='store_true',\n dest='https', help='Specify that https '\n 'should be used.')\n self.option_parser.add_option('--cert-and-key-file',\n dest='cert_and_key_file', help='specify the '\n 'path to the file containing the certificate '\n 'and private key for the server in PEM '\n 'format')\n self.option_parser.add_option('--ocsp', dest='ocsp', default='ok',\n help='The type of OCSP response generated '\n 'for the automatically generated '\n 'certificate. One of [ok,revoked,invalid]')\n self.option_parser.add_option('--cert-serial', dest='cert_serial',\n default=0, type=int,\n help='If non-zero then the generated '\n 'certificate will have this serial number')\n self.option_parser.add_option('--tls-intolerant', dest='tls_intolerant',\n default='0', type='int',\n help='If nonzero, certain TLS connections '\n 'will be aborted in order to test version '\n 'fallback. 1 means all TLS versions will be '\n 'aborted. 2 means TLS 1.1 or higher will be '\n 'aborted. 3 means TLS 1.2 or higher will be '\n 'aborted.')\n self.option_parser.add_option('--tls-intolerance-type',\n dest='tls_intolerance_type',\n default=\"alert\",\n help='Controls how the server reacts to a '\n 'TLS version it is intolerant to. Valid '\n 'values are \"alert\", \"close\", and \"reset\".')\n self.option_parser.add_option('--signed-cert-timestamps-tls-ext',\n dest='signed_cert_timestamps_tls_ext',\n default='',\n help='Base64 encoded SCT list. If set, '\n 'server will respond with a '\n 'signed_certificate_timestamp TLS extension '\n 'whenever the client supports it.')\n self.option_parser.add_option('--fallback-scsv', dest='fallback_scsv',\n default=False, const=True,\n action='store_const',\n help='If given, TLS_FALLBACK_SCSV support '\n 'will be enabled. This causes the server to '\n 'reject fallback connections from compatible '\n 'clients (e.g. Chrome).')\n self.option_parser.add_option('--staple-ocsp-response',\n dest='staple_ocsp_response',\n default=False, action='store_true',\n help='If set, server will staple the OCSP '\n 'response whenever OCSP is on and the client '\n 'supports OCSP stapling.')\n self.option_parser.add_option('--https-record-resume',\n dest='record_resume', const=True,\n default=False, action='store_const',\n help='Record resumption cache events rather '\n 'than resuming as normal. Allows the use of '\n 'the /ssl-session-cache request')\n self.option_parser.add_option('--ssl-client-auth', action='store_true',\n help='Require SSL client auth on every '\n 'connection.')\n self.option_parser.add_option('--ssl-client-ca', action='append',\n default=[], help='Specify that the client '\n 'certificate request should include the CA '\n 'named in the subject of the DER-encoded '\n 'certificate contained in the specified '\n 'file. This option may appear multiple '\n 'times, indicating multiple CA names should '\n 'be sent in the request.')\n self.option_parser.add_option('--ssl-client-cert-type', action='append',\n default=[], help='Specify that the client '\n 'certificate request should include the '\n 'specified certificate_type value. This '\n 'option may appear multiple times, '\n 'indicating multiple values should be send '\n 'in the request. Valid values are '\n '\"rsa_sign\", \"dss_sign\", and \"ecdsa_sign\". '\n 'If omitted, \"rsa_sign\" will be used.')\n self.option_parser.add_option('--ssl-bulk-cipher', action='append',\n help='Specify the bulk encryption '\n 'algorithm(s) that will be accepted by the '\n 'SSL server. Valid values are \"aes128gcm\", '\n '\"aes256\", \"aes128\", \"3des\", \"rc4\". If '\n 'omitted, all algorithms will be used. This '\n 'option may appear multiple times, '\n 'indicating multiple algorithms should be '\n 'enabled.');\n self.option_parser.add_option('--ssl-key-exchange', action='append',\n help='Specify the key exchange algorithm(s)'\n 'that will be accepted by the SSL server. '\n 'Valid values are \"rsa\", \"dhe_rsa\", '\n '\"ecdhe_rsa\". If omitted, all algorithms '\n 'will be used. This option may appear '\n 'multiple times, indicating multiple '\n 'algorithms should be enabled.');\n # TODO(davidben): Add ALPN support to tlslite.\n self.option_parser.add_option('--enable-npn', dest='enable_npn',\n default=False, const=True,\n action='store_const',\n help='Enable server support for the NPN '\n 'extension. The server will advertise '\n 'support for exactly one protocol, http/1.1')\n self.option_parser.add_option('--file-root-url', default='/files/',\n help='Specify a root URL for files served.')\n # TODO(ricea): Generalize this to support basic auth for HTTP too.\n self.option_parser.add_option('--ws-basic-auth', action='store_true',\n dest='ws_basic_auth',\n help='Enable basic-auth for WebSocket')\n self.option_parser.add_option('--ocsp-server-unavailable',\n dest='ocsp_server_unavailable',\n default=False, action='store_true',\n help='If set, the OCSP server will return '\n 'a tryLater status rather than the actual '\n 'OCSP response.')\n self.option_parser.add_option('--alert-after-handshake',\n dest='alert_after_handshake',\n default=False, action='store_true',\n help='If set, the server will send a fatal '\n 'alert immediately after the handshake.')\n self.option_parser.add_option('--no-anonymous-ftp-user',\n dest='no_anonymous_ftp_user',\n default=False, action='store_true',\n help='If set, the FTP server will not create '\n 'an anonymous user.')\n\n\nif __name__ == '__main__':\n sys.exit(ServerRunner().main())\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227993,"cells":{"text":{"kind":"string","value":"# -*- coding: utf-8 -*-\n\n\"\"\" Framework for filtered REST requests\n\n @copyright: 2013-14 (c) Sahana Software Foundation\n @license: MIT\n\n @requires: U{B{I{gluon}} <http://web2py.com>}\n\n Permission is hereby granted, free of charge, to any person\n obtaining a copy of this software and associated documentation\n files (the \"Software\"), to deal in the Software without\n restriction, including without limitation the rights to use,\n copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the\n Software is furnished to do so, subject to the following\n conditions:\n\n The above copyright notice and this permission notice shall be\n included in all copies or substantial portions of the Software.\n\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\n OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\n HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\n WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\n OTHER DEALINGS IN THE SOFTWARE.\n\"\"\"\n\nimport datetime\nimport re\n\ntry:\n import json # try stdlib (Python 2.6)\nexcept ImportError:\n try:\n import simplejson as json # try external module\n except:\n import gluon.contrib.simplejson as json # fallback to pure-Python module\n\ntry:\n # Python 2.7\n from collections import OrderedDict\nexcept:\n # Python 2.6\n from gluon.contrib.simplejson.ordered_dict import OrderedDict\n\nfrom gluon import *\nfrom gluon.sqlhtml import MultipleOptionsWidget\nfrom gluon.storage import Storage\nfrom gluon.tools import callback\n\nfrom s3rest import S3Method\nfrom s3resource import S3ResourceField, S3URLQuery\nfrom s3utils import s3_get_foreign_key, s3_unicode, S3TypeConverter\nfrom s3validators import *\nfrom s3widgets import S3DateWidget, S3DateTimeWidget, S3GroupedOptionsWidget, S3MultiSelectWidget, S3HierarchyWidget\n\n# Compact JSON encoding\nSEPARATORS = (\",\", \":\")\n\n# =============================================================================\ndef get_s3_filter_opts(tablename,\n fieldname = \"name\",\n location_filter = False,\n org_filter = False,\n none = False,\n translate = False,\n ):\n \"\"\"\n Lazy options getter\n - this is useful when the expected number of options is significantly smaller than the number of records to iterate through\n NB This reason is no longer required with S3Filter, but is a legacy from S3Search: S3Filter already does an efficient Reverse-Query\n @ToDo: Deprecate\n - note this doesn't check if options are actually in-use\n\n @param tablename: the name of the lookup table\n @param fieldname: the name of the field to represent options with\n @param location_filter: whether to filter the values by location\n @param org_filter: whether to filter the values by root_org\n @param none: whether to include an option for None\n @param translate: whether to translate the values\n \"\"\"\n\n auth = current.auth\n table = current.s3db.table(tablename)\n if auth.s3_has_permission(\"read\", table):\n query = auth.s3_accessible_query(\"read\", table)\n if location_filter:\n location = current.session.s3.location_filter\n if location:\n query &= (table.location_id == location)\n if org_filter:\n root_org = auth.root_org()\n if root_org:\n query &= ((table.organisation_id == root_org) | \\\n (table.organisation_id == None))\n #else:\n # query &= (table.organisation_id == None)\n rows = current.db(query).select(table.id,\n table[fieldname],\n # Options are sorted later\n #orderby = table[fieldname]\n )\n if translate:\n T = current.T\n opts = dict((row.id, T(row[fieldname])) for row in rows)\n else:\n opts = dict((row.id, row[fieldname]) for row in rows)\n if none:\n opts[None] = current.messages[\"NONE\"]\n else:\n opts = {}\n return opts\n\n# =============================================================================\nclass S3FilterWidget(object):\n \"\"\" Filter widget for interactive search forms (base class) \"\"\"\n\n #: the HTML class for the widget type\n _class = \"generic-filter\"\n\n #: the default query operator(s) for the widget type\n operator = None\n\n #: alternatives for client-side changeable operators\n alternatives = None\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Prototype method to render this widget as an instance of\n a web2py HTML helper class, to be implemented by subclasses.\n\n @param resource: the S3Resource to render with widget for\n @param values: the values for this widget from the URL query\n \"\"\"\n\n raise NotImplementedError\n\n # -------------------------------------------------------------------------\n def variable(self, resource, get_vars=None):\n \"\"\"\n Prototype method to generate the name for the URL query variable\n for this widget, can be overwritten in subclasses.\n\n @param resource: the resource\n @return: the URL query variable name (or list of\n variable names if there are multiple operators)\n \"\"\"\n\n label, self.selector = self._selector(resource, self.field)\n\n if not self.selector:\n return None\n\n if self.alternatives and get_vars is not None:\n # Get the actual operator from get_vars\n operator = self._operator(get_vars, self.selector)\n if operator:\n self.operator = operator\n\n if \"label\" not in self.opts:\n self.opts[\"label\"] = label\n\n return self._variable(self.selector, self.operator)\n\n # -------------------------------------------------------------------------\n def data_element(self, variable):\n \"\"\"\n Prototype method to construct the hidden element that holds the\n URL query term corresponding to an input element in the widget.\n\n @param variable: the URL query variable\n \"\"\"\n\n if type(variable) is list:\n variable = \"&\".join(variable)\n return INPUT(_type=\"hidden\",\n _id=\"%s-data\" % self.attr[\"_id\"],\n _class=\"filter-widget-data %s-data\" % self._class,\n _value=variable)\n\n # -------------------------------------------------------------------------\n # Helper methods\n #\n def __init__(self, field=None, **attr):\n \"\"\"\n Constructor to configure the widget\n\n @param field: the selector(s) for the field(s) to filter by\n @param attr: configuration options for this widget\n\n Configuration options:\n @keyword label: label for the widget\n @keyword comment: comment for the widget\n @keyword hidden: render widget initially hidden (=\"advanced\"\n option)\n @keyword levels: list of location hierarchy levels\n (L{S3LocationFilter})\n @keyword widget: widget to use (L{S3OptionsFilter}),\n \"select\", \"multiselect\" (default), \n or \"groupedopts\"\n @keyword cols: number of columns of checkboxes (L{S3OptionsFilter}\n and L{S3LocationFilter} with \"groupedopts\" widget)\n @keyword filter: show filter for options (L{S3OptionsFilter},\n L{S3LocationFilter} with \"multiselect\" widget)\n @keyword header: show header in widget (L{S3OptionsFilter},\n L{S3LocationFilter} with \"multiselect\" widget)\n @keyword selectedList: number of selected items to show before\n collapsing into number of items\n (L{S3OptionsFilter}, L{S3LocationFilter}\n with \"multiselect\" widget)\n @keyword no_opts: text to show if no options available\n (L{S3OptionsFilter}, L{S3LocationFilter})\n @keyword resource: alternative resource to look up options\n (L{S3LocationFilter}, L{S3OptionsFilter})\n @keyword lookup: field in the alternative resource to look up\n options (L{S3LocationFilter})\n @keyword options: fixed set of options (L{S3OptionsFilter}: dict\n of {value: label} or a callable that returns one,\n L{S3LocationFilter}: list of gis_location IDs)\n @keyword size: maximum size of multi-letter options groups\n (L{S3OptionsFilter} with \"groupedopts\" widget)\n @keyword help_field: field in the referenced table to display on\n hovering over a foreign key option\n (L{S3OptionsFilter} with \"groupedopts\" widget)\n @keyword none: label for explicit None-option in many-to-many\n fields (L{S3OptionsFilter})\n @keyword fieldtype: explicit field type \"date\" or \"datetime\" to\n use for context or virtual fields\n (L{S3DateFilter})\n @keyword hide_time: don't show time selector (L{S3DateFilter})\n \"\"\"\n\n self.field = field\n self.alias = None\n\n attributes = Storage()\n options = Storage()\n for k, v in attr.iteritems():\n if k[0] == \"_\":\n attributes[k] = v\n else:\n options[k] = v\n self.attr = attributes\n self.opts = options\n\n self.selector = None\n self.values = Storage()\n\n # -------------------------------------------------------------------------\n def __call__(self, resource, get_vars=None, alias=None):\n \"\"\"\n Entry point for the form builder\n\n @param resource: the S3Resource to render the widget for\n @param get_vars: the GET vars (URL query vars) to prepopulate\n the widget\n @param alias: the resource alias to use\n \"\"\"\n\n self.alias = alias\n\n # Initialize the widget attributes\n self._attr(resource)\n\n # Extract the URL values to populate the widget\n variable = self.variable(resource, get_vars)\n if type(variable) is list:\n values = Storage()\n for k in variable:\n if k in self.values:\n values[k] = self.values[k]\n else:\n values[k] = self._values(get_vars, k)\n else:\n if variable in self.values:\n values = self.values[variable]\n else:\n values = self._values(get_vars, variable)\n\n # Construct and populate the widget\n widget = self.widget(resource, values)\n\n # Recompute variable in case operator got changed in widget()\n if self.alternatives:\n variable = self._variable(self.selector, self.operator)\n\n # Construct the hidden data element\n data = self.data_element(variable)\n\n if type(data) is list:\n data.append(widget)\n else:\n data = [data, widget]\n return TAG[\"\"](*data)\n\n # -------------------------------------------------------------------------\n def _attr(self, resource):\n \"\"\" Initialize and return the HTML attributes for this widget \"\"\"\n\n _class = self._class\n\n # Construct name and id for the widget\n attr = self.attr\n if \"_name\" not in attr:\n if not resource:\n raise SyntaxError(\"%s: _name parameter required \" \\\n \"when rendered without resource.\" % \\\n self.__class__.__name__)\n flist = self.field\n if type(flist) is not list:\n flist = [flist]\n colnames = []\n for f in flist:\n rfield = S3ResourceField(resource, f)\n colname = rfield.colname\n if colname:\n colnames.append(colname)\n else:\n colnames.append(rfield.fname)\n name = \"%s-%s-%s\" % (resource.alias, \"-\".join(colnames), _class)\n attr[\"_name\"] = name.replace(\".\", \"_\")\n if \"_id\" not in attr:\n attr[\"_id\"] = attr[\"_name\"]\n\n return attr\n\n # -------------------------------------------------------------------------\n @classmethod\n def _operator(cls, get_vars, selector):\n \"\"\"\n Helper method to get the operators from the URL query\n\n @param get_vars: the GET vars (a dict)\n @param selector: field selector\n\n @return: query operator - None, str or list\n \"\"\"\n\n variables = [\"%s__%s\" % (selector, op) for op in cls.alternatives]\n slen = len(selector) + 2\n\n operators = [k[slen:] for k, v in get_vars.iteritems()\n if k in variables]\n if not operators:\n return None\n elif len(operators) == 1:\n return operators[0]\n else:\n return operators\n\n # -------------------------------------------------------------------------\n def _prefix(self, selector):\n \"\"\"\n Helper method to prefix an unprefixed field selector\n\n @param alias: the resource alias to use as prefix\n @param selector: the field selector\n\n @return: the prefixed selector\n \"\"\"\n\n alias = self.alias\n if alias is None:\n alias = \"~\"\n if \".\" not in selector.split(\"$\", 1)[0]:\n return \"%s.%s\" % (alias, selector)\n else:\n return selector\n\n # -------------------------------------------------------------------------\n def _selector(self, resource, fields):\n \"\"\"\n Helper method to generate a filter query selector for the\n given field(s) in the given resource.\n\n @param resource: the S3Resource\n @param fields: the field selectors (as strings)\n\n @return: the field label and the filter query selector, or None\n if none of the field selectors could be resolved\n \"\"\"\n\n prefix = self._prefix\n label = None\n\n if not fields:\n return label, None\n if not isinstance(fields, (list, tuple)):\n fields = [fields]\n selectors = []\n for field in fields:\n if resource:\n try:\n rfield = S3ResourceField(resource, field)\n except (AttributeError, TypeError):\n continue\n if not rfield.field and not rfield.virtual:\n # Unresolvable selector\n continue\n if not label:\n label = rfield.label\n selectors.append(prefix(rfield.selector))\n else:\n selectors.append(field)\n if selectors:\n return label, \"|\".join(selectors)\n else:\n return label, None\n\n # -------------------------------------------------------------------------\n @staticmethod\n def _values(get_vars, variable):\n \"\"\"\n Helper method to get all values of a URL query variable\n\n @param get_vars: the GET vars (a dict)\n @param variable: the name of the query variable\n\n @return: a list of values\n \"\"\"\n\n if not variable:\n return []\n elif variable in get_vars:\n values = S3URLQuery.parse_value(get_vars[variable])\n if not isinstance(values, (list, tuple)):\n values = [values]\n return values\n else:\n return []\n\n # -------------------------------------------------------------------------\n @classmethod\n def _variable(cls, selector, operator):\n \"\"\"\n Construct URL query variable(s) name from a filter query\n selector and the given operator(s)\n\n @param selector: the selector\n @param operator: the operator (or tuple/list of operators)\n\n @return: the URL query variable name (or list of variable names)\n \"\"\"\n\n if isinstance(operator, (tuple, list)):\n return [cls._variable(selector, o) for o in operator]\n elif operator:\n return \"%s__%s\" % (selector, operator)\n else:\n return selector\n\n# =============================================================================\nclass S3TextFilter(S3FilterWidget):\n \"\"\" Text filter widget \"\"\"\n\n _class = \"text-filter\"\n\n operator = \"like\"\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Render this widget as HTML helper object(s)\n\n @param resource: the resource\n @param values: the search values from the URL query\n \"\"\"\n\n attr = self.attr\n\n if \"_size\" not in attr:\n attr.update(_size=\"40\")\n if \"_class\" in attr and attr[\"_class\"]:\n _class = \"%s %s\" % (attr[\"_class\"], self._class)\n else:\n _class = self._class\n attr[\"_class\"] = _class\n attr[\"_type\"] = \"text\"\n\n values = [v.strip(\"*\") for v in values if v is not None]\n if values:\n attr[\"_value\"] = \" \".join(values)\n\n return INPUT(**attr)\n\n# =============================================================================\nclass S3RangeFilter(S3FilterWidget):\n \"\"\" Numerical Range Filter Widget \"\"\"\n\n # Overall class\n _class = \"range-filter\"\n # Class for visible input boxes.\n _input_class = \"%s-%s\" % (_class, \"input\")\n\n operator = [\"ge\", \"le\"]\n\n # Untranslated labels for individual input boxes.\n input_labels = {\"ge\": \"Minimum\", \"le\": \"Maximum\"}\n\n # -------------------------------------------------------------------------\n def data_element(self, variables):\n \"\"\"\n Overrides S3FilterWidget.data_element(), constructs multiple\n hidden INPUTs (one per variable) with element IDs of the form\n <id>-<operator>-data (where no operator is translated as \"eq\").\n\n @param variables: the variables\n \"\"\"\n\n if variables is None:\n operators = self.operator\n if type(operators) is not list:\n operators = [operators]\n variables = self._variable(self.selector, operators)\n else:\n\n # Split the operators off the ends of the variables.\n if type(variables) is not list:\n variables = [variables]\n operators = [v.split(\"__\")[1]\n if \"__\" in v else \"eq\"\n for v in variables]\n\n elements = []\n id = self.attr[\"_id\"]\n\n for o, v in zip(operators, variables):\n elements.append(\n INPUT(_type=\"hidden\",\n _id=\"%s-%s-data\" % (id, o),\n _class=\"filter-widget-data %s-data\" % self._class,\n _value=v))\n\n return elements\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Render this widget as HTML helper object(s)\n\n @param resource: the resource\n @param values: the search values from the URL query\n \"\"\"\n\n attr = self.attr\n _class = self._class\n if \"_class\" in attr and attr[\"_class\"]:\n _class = \"%s %s\" % (attr[\"_class\"], _class)\n else:\n _class = _class\n attr[\"_class\"] = _class\n\n input_class = self._input_class\n input_labels = self.input_labels\n input_elements = DIV()\n ie_append = input_elements.append\n\n selector = self.selector\n\n _variable = self._variable\n\n id = attr[\"_id\"]\n for operator in self.operator:\n\n input_id = \"%s-%s\" % (id, operator)\n\n input_box = INPUT(_name=input_id,\n _id=input_id,\n _type=\"text\",\n _class=input_class)\n\n variable = _variable(selector, operator)\n\n # Populate with the value, if given\n # if user has not set any of the limits, we get [] in values.\n value = values.get(variable, None)\n if value not in [None, []]:\n if type(value) is list:\n value = value[0]\n input_box[\"_value\"] = value\n input_box[\"value\"] = value\n\n ie_append(DIV(\n DIV(LABEL(current.T(input_labels[operator] + \":\"),\n _for=input_id),\n _class=\"range-filter-label\"),\n DIV(input_box,\n _class=\"range-filter-widget\"),\n _class=\"range-filter-field\"))\n\n return input_elements\n\n# =============================================================================\nclass S3DateFilter(S3RangeFilter):\n \"\"\"\n Date Range Filter Widget\n @see: L{Configuration Options<S3FilterWidget.__init__>}\n \"\"\"\n\n _class = \"date-filter\"\n\n # Class for visible input boxes.\n _input_class = \"%s-%s\" % (_class, \"input\")\n\n operator = [\"ge\", \"le\"]\n\n # Untranslated labels for individual input boxes.\n input_labels = {\"ge\": \"From\", \"le\": \"To\"}\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Render this widget as HTML helper object(s)\n\n @param resource: the resource\n @param values: the search values from the URL query\n \"\"\"\n\n attr = self.attr\n\n # CSS class and element ID\n _class = self._class\n if \"_class\" in attr and attr[\"_class\"]:\n _class = \"%s %s\" % (attr[\"_class\"], _class)\n else:\n _class = _class\n _id = attr[\"_id\"]\n\n # Determine the field type\n if resource:\n rfield = S3ResourceField(resource, self.field)\n field = rfield.field\n else:\n rfield = field = None\n if not field:\n if not rfield or rfield.virtual:\n ftype = self.opts.get(\"fieldtype\", \"datetime\")\n else:\n # Unresolvable selector\n return \"\"\n else:\n ftype = rfield.ftype\n if not field:\n # S3DateTimeWidget requires a Field\n if rfield:\n tname, fname = rfield.tname, rfield.fname\n else:\n tname, fname = \"notable\", \"datetime\"\n if not _id:\n raise SyntaxError(\"%s: _id parameter required \" \\\n \"when rendered without resource.\" % \\\n self.__class__.__name__)\n dtformat = current.deployment_settings.get_L10n_date_format()\n field = Field(fname, ftype,\n requires = IS_DATE_IN_RANGE(format = dtformat))\n field.tablename = field._tablename = tname\n\n # Options\n hide_time = self.opts.get(\"hide_time\", False)\n\n # Generate the input elements\n T = current.T\n selector = self.selector\n _variable = self._variable\n input_class = self._input_class\n input_labels = self.input_labels\n input_elements = DIV(_id=_id, _class=_class)\n append = input_elements.append\n for operator in self.operator:\n\n input_id = \"%s-%s\" % (_id, operator)\n\n # Determine the widget class\n if ftype == \"date\":\n widget = S3DateWidget()\n else:\n opts = {}\n if operator == \"ge\":\n opts[\"set_min\"] = \"%s-%s\" % (_id, \"le\")\n elif operator == \"le\":\n opts[\"set_max\"] = \"%s-%s\" % (_id, \"ge\")\n widget = S3DateTimeWidget(hide_time=hide_time, **opts)\n\n # Populate with the value, if given\n # if user has not set any of the limits, we get [] in values.\n variable = _variable(selector, operator)\n value = values.get(variable, None)\n if value not in [None, []]:\n if type(value) is list:\n value = value[0]\n else:\n value = None\n\n # Render the widget\n picker = widget(field, value,\n _name=input_id,\n _id=input_id,\n _class=input_class)\n\n # Append label and widget\n append(DIV(\n DIV(LABEL(\"%s:\" % T(input_labels[operator]),\n _for=input_id),\n _class=\"range-filter-label\"),\n DIV(picker,\n _class=\"range-filter-widget\"),\n _class=\"range-filter-field\"))\n\n return input_elements\n\n# =============================================================================\nclass S3LocationFilter(S3FilterWidget):\n \"\"\"\n Hierarchical Location Filter Widget\n @see: L{Configuration Options<S3FilterWidget.__init__>}\n\n NB This will show records linked to all child locations of the Lx\n \"\"\"\n\n _class = \"location-filter\"\n\n operator = \"belongs\"\n\n # -------------------------------------------------------------------------\n def __init__(self, field=None, **attr):\n \"\"\"\n Constructor to configure the widget\n\n @param field: the selector(s) for the field(s) to filter by\n @param attr: configuration options for this widget\n \"\"\"\n\n # Translate options using gis_location_name?\n settings = current.deployment_settings\n translate = settings.get_L10n_translate_gis_location()\n if translate:\n language = current.session.s3.language\n if language == settings.get_L10n_default_language():\n translate = False\n self.translate = translate\n\n super(S3LocationFilter, self).__init__(field=field, **attr)\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Render this widget as HTML helper object(s)\n\n @param resource: the resource\n @param values: the search values from the URL query\n \"\"\"\n\n attr = self._attr(resource)\n opts = self.opts\n name = attr[\"_name\"]\n\n ftype, levels, noopt = self._options(resource, values=values)\n if noopt:\n return SPAN(noopt, _class=\"no-options-available\")\n\n # Filter class (default+custom)\n _class = self._class\n if \"_class\" in attr and attr[\"_class\"]:\n _class = \"%s %s\" % (_class, attr[\"_class\"])\n attr[\"_class\"] = _class\n\n # Store id and name for the data element\n base_id = attr[\"_id\"]\n base_name = attr[\"_name\"]\n\n widgets = []\n w_append = widgets.append\n operator = self.operator\n field_name = self.field\n\n fname = self._prefix(field_name) if resource else field_name\n\n #widget_type = opts[\"widget\"]\n # Use groupedopts widget if we specify cols, otherwise assume multiselect\n cols = opts.get(\"cols\", None)\n if cols:\n # Grouped Checkboxes\n # @ToDo: somehow working, but ugly, not usable (deprecated?)\n if \"groupedopts-filter-widget\" not in _class:\n attr[\"_class\"] = \"%s groupedopts-filter-widget\" % _class\n attr[\"cols\"] = cols\n\n # Add one widget per level\n for level in levels:\n options = levels[level][\"options\"]\n groupedopts = S3GroupedOptionsWidget(cols = cols,\n size = opts[\"size\"] or 12,\n )\n # Dummy field\n name = \"%s-%s\" % (base_name, level)\n dummy_field = Storage(name=name,\n type=ftype,\n requires=IS_IN_SET(options,\n multiple=True))\n # Unique ID/name\n attr[\"_id\"] = \"%s-%s\" % (base_id, level)\n attr[\"_name\"] = name\n \n # Find relevant values to pre-populate\n _values = values.get(\"%s$%s__%s\" % (fname, level, operator))\n w_append(groupedopts(dummy_field, _values, **attr))\n\n else:\n # Multiselect is default\n T = current.T\n\n # Multiselect Dropdown with Checkboxes\n if \"multiselect-filter-widget\" not in _class:\n _class = \"%s multiselect-filter-widget\" % _class\n\n # Add one widget per level\n first = True\n hide = True\n for level in levels:\n # Dummy field\n name = \"%s-%s\" % (base_name, level)\n options = levels[level][\"options\"]\n dummy_field = Storage(name=name,\n type=ftype,\n requires=IS_IN_SET(options,\n multiple=True))\n # Unique ID/name\n attr[\"_id\"] = \"%s-%s\" % (base_id, level)\n attr[\"_name\"] = name\n # Find relevant values to pre-populate the widget\n _values = values.get(\"%s$%s__%s\" % (fname, level, operator))\n w = S3MultiSelectWidget(filter = opts.get(\"filter\", \"auto\"),\n header = opts.get(\"header\", False),\n selectedList = opts.get(\"selectedList\", 3),\n noneSelectedText = T(\"Select %(location)s\") % \\\n dict(location=levels[level][\"label\"]))\n if first:\n attr[\"_class\"] = _class\n elif hide:\n # Hide dropdowns other than first\n _class = \"%s hide\" % _class\n attr[\"_class\"] = _class\n hide = False\n widget = w(dummy_field, _values, **attr)\n w_append(widget)\n first = False\n\n # Restore id and name for the data_element\n attr[\"_id\"] = base_id\n attr[\"_name\"] = base_name\n\n # Render the filter widget\n return TAG[\"\"](*widgets)\n\n # -------------------------------------------------------------------------\n def data_element(self, variable):\n \"\"\"\n Construct the hidden element that holds the\n URL query term corresponding to an input element in the widget.\n\n @param variable: the URL query variable\n \"\"\"\n\n output = []\n oappend = output.append\n i = 0\n for level in self.levels:\n widget = INPUT(_type=\"hidden\",\n _id=\"%s-%s-data\" % (self.attr[\"_id\"], level),\n _class=\"filter-widget-data %s-data\" % self._class,\n _value=variable[i])\n oappend(widget)\n i += 1\n\n return output\n\n # -------------------------------------------------------------------------\n def ajax_options(self, resource):\n\n attr = self._attr(resource)\n ftype, levels, noopt = self._options(resource, inject_hierarchy=False)\n\n opts = {}\n base_id = attr[\"_id\"]\n for level in levels:\n if noopt:\n opts[\"%s-%s\" % (base_id, level)] = str(noopt)\n else:\n options = levels[level][\"options\"]\n opts[\"%s-%s\" % (base_id, level)] = options\n return opts\n\n # -------------------------------------------------------------------------\n @staticmethod\n def __options(row, levels, inject_hierarchy, hierarchy, _level, translate, name_l10n):\n\n if inject_hierarchy:\n parent = None\n grandparent = None\n greatgrandparent = None\n greatgreatgrandparent = None\n greatgreatgreatgrandparent = None\n i = 0\n for level in levels:\n v = row[level]\n if v:\n o = levels[level][\"options\"]\n if v not in o:\n if translate:\n o[v] = name_l10n.get(v, v)\n else:\n o.append(v)\n if inject_hierarchy:\n if i == 0:\n h = hierarchy[_level]\n if v not in h:\n h[v] = {}\n parent = v\n elif i == 1:\n h = hierarchy[_level][parent]\n if v not in h:\n h[v] = {}\n grandparent = parent\n parent = v\n elif i == 2:\n h = hierarchy[_level][grandparent][parent]\n if v not in h:\n h[v] = {}\n greatgrandparent = grandparent\n grandparent = parent\n parent = v\n elif i == 3:\n h = hierarchy[_level][greatgrandparent][grandparent][parent]\n if v not in h:\n h[v] = {}\n greatgreatgrandparent = greatgrandparent\n greatgrandparent = grandparent\n grandparent = parent\n parent = v\n elif i == 4:\n h = hierarchy[_level][greatgreatgrandparent][greatgrandparent][grandparent][parent]\n if v not in h:\n h[v] = {}\n greatgreatgreatgrandparent = greatgreatgrandparent\n greatgreatgrandparent = greatgrandparent\n greatgrandparent = grandparent\n grandparent = parent\n parent = v\n elif i == 5:\n h = hierarchy[_level][greatgreatgreatgrandparent][greatgreatgrandparent][greatgrandparent][grandparent][parent]\n if v not in h:\n h[v] = {}\n i += 1\n\n # -------------------------------------------------------------------------\n def _options(self, resource, inject_hierarchy=True, values=None):\n\n T = current.T\n s3db = current.s3db\n gtable = s3db.gis_location\n\n NOOPT = T(\"No options available\")\n\n #attr = self.attr\n opts = self.opts\n translate = self.translate\n\n # Which levels should we display?\n # Lookup the appropriate labels from the GIS configuration\n hierarchy = current.gis.get_location_hierarchy()\n levels = OrderedDict()\n if \"levels\" in opts:\n for level in opts[\"levels\"]:\n levels[level] = hierarchy.get(level, level)\n else:\n if len(current.deployment_settings.get_gis_countries()) == 1 or \\\n current.response.s3.gis.config.region_location_id:\n try:\n del hierarchy[\"L0\"]\n except KeyError:\n pass\n for level in hierarchy:\n levels[level] = hierarchy.get(level, level)\n # Pass to data_element\n self.levels = levels\n\n if \"label\" not in opts:\n opts[\"label\"] = T(\"Filter by Location\")\n\n ftype = \"reference gis_location\"\n default = (ftype, levels.keys(), opts.get(\"no_opts\", NOOPT))\n\n # Resolve the field selector\n selector = None\n if resource is None:\n rname = opts.get(\"resource\")\n if rname:\n resource = s3db.resource(rname)\n selector = opts.get(\"lookup\", \"location_id\")\n else:\n selector = self.field\n\n options = opts.get(\"options\")\n if options:\n # Fixed options (=list of location IDs)\n resource = s3db.resource(\"gis_location\", id=options)\n fields = [\"id\"] + [l for l in levels]\n if translate:\n fields.append(\"path\")\n joined = False\n\n elif selector:\n # Lookup options from resource\n rfield = S3ResourceField(resource, selector)\n if not rfield.field or rfield.ftype != ftype:\n # Must be a real reference to gis_location\n return default\n fields = [selector] + [\"%s$%s\" % (selector, l) for l in levels]\n if translate:\n fields.append(\"%s$path\" % selector)\n joined = True\n # Filter out old Locations\n # @ToDo: Allow override\n resource.add_filter(gtable.end_date == None)\n\n else:\n # Neither fixed options nor resource to look them up\n return default\n\n # Find the options\n rows = resource.select(fields=fields,\n limit=None,\n virtual=False,\n as_rows=True)\n rows2 = []\n if not rows:\n if values:\n # Make sure the selected options are in the available options\n resource = s3db.resource(\"gis_location\")\n fields = [\"id\"] + [l for l in levels]\n if translate:\n fields.append(\"path\")\n joined = False\n rows = []\n for f in values:\n v = values[f]\n if not v:\n continue\n level = \"L%s\" % f.split(\"L\", 1)[1][0]\n resource.clear_query()\n query = (gtable.level == level) & \\\n (gtable.name.belongs(v))\n resource.add_filter(query)\n # Filter out old Locations\n # @ToDo: Allow override\n resource.add_filter(gtable.end_date == None)\n _rows = resource.select(fields=fields,\n limit=None,\n virtual=False,\n as_rows=True)\n if rows:\n rows &= _rows\n else:\n rows = _rows\n\n if not rows:\n # No options\n return default\n\n elif values:\n # Make sure the selected options are in the available options\n resource2 = s3db.resource(\"gis_location\")\n fields = [\"id\"] + [l for l in levels]\n if translate:\n fields.append(\"path\")\n for f in values:\n v = values[f]\n if not v:\n continue\n level = \"L%s\" % f.split(\"L\", 1)[1][0]\n resource2.clear_query()\n query = (gtable.level == level) & \\\n (gtable.name.belongs(v))\n resource2.add_filter(query)\n # Filter out old Locations\n # @ToDo: Allow override\n resource2.add_filter(gtable.end_date == None)\n _rows = resource2.select(fields=fields,\n limit=None,\n virtual=False,\n as_rows=True)\n if rows2:\n rows2 &= _rows\n else:\n rows2 = _rows\n\n # Initialise Options Storage & Hierarchy\n hierarchy = {}\n first = True\n for level in levels:\n if first:\n hierarchy[level] = {}\n _level = level\n first = False\n levels[level] = {\"label\": levels[level],\n \"options\": {} if translate else [],\n }\n\n # Generate a name localization lookup dict\n name_l10n = {}\n if translate:\n # Get IDs via Path to lookup name_l10n\n ids = set()\n if joined:\n if \"$\" in selector:\n selector = \"%s.%s\" % (rfield.field.tablename, selector.split(\"$\", 1)[1])\n elif \".\" in selector:\n selector = \"%s.%s\" % (rfield.field.tablename, selector.split(\".\", 1)[1])\n else:\n selector = \"%s.%s\" % (resource.tablename, selector)\n for row in rows:\n _row = getattr(row, \"gis_location\") if joined else row\n path = _row.path\n if path:\n path = path.split(\"/\")\n else:\n # Build it\n if joined:\n location_id = row[selector]\n if location_id:\n _row.id = location_id\n if \"id\" in _row:\n path = current.gis.update_location_tree(_row)\n path = path.split(\"/\")\n if path:\n ids |= set(path)\n for row in rows2:\n path = row.path\n if path:\n path = path.split(\"/\")\n else:\n # Build it\n if \"id\" in row:\n path = current.gis.update_location_tree(row)\n path = path.split(\"/\")\n if path:\n ids |= set(path)\n # Build lookup table for name_l10n\n ntable = s3db.gis_location_name\n query = (gtable.id.belongs(ids)) & \\\n (ntable.deleted == False) & \\\n (ntable.location_id == gtable.id) & \\\n (ntable.language == current.session.s3.language)\n nrows = current.db(query).select(gtable.name,\n ntable.name_l10n,\n limitby=(0, len(ids)),\n )\n for row in nrows:\n name_l10n[row[\"gis_location.name\"]] = row[\"gis_location_name.name_l10n\"]\n\n # Populate the Options and the Hierarchy\n for row in rows:\n _row = getattr(row, \"gis_location\") if joined else row\n self.__options(_row, levels, inject_hierarchy, hierarchy, _level, translate, name_l10n)\n for row in rows2:\n self.__options(row, levels, inject_hierarchy, hierarchy, _level, translate, name_l10n)\n\n if translate:\n # Sort the options dicts\n for level in levels:\n options = levels[level][\"options\"]\n options = OrderedDict(sorted(options.iteritems()))\n else:\n # Sort the options lists\n for level in levels:\n levels[level][\"options\"].sort()\n\n if inject_hierarchy:\n # Inject the Location Hierarchy\n hierarchy = \"S3.location_filter_hierarchy=%s\" % \\\n json.dumps(hierarchy, separators=SEPARATORS)\n js_global = current.response.s3.js_global\n js_global.append(hierarchy)\n if translate:\n # Inject lookup list\n name_l10n = \"S3.location_name_l10n=%s\" % \\\n json.dumps(name_l10n, separators=SEPARATORS)\n js_global.append(name_l10n)\n\n return (ftype, levels, None)\n\n # -------------------------------------------------------------------------\n def _selector(self, resource, fields):\n \"\"\"\n Helper method to generate a filter query selector for the\n given field(s) in the given resource.\n\n @param resource: the S3Resource\n @param fields: the field selectors (as strings)\n\n @return: the field label and the filter query selector, or None if none of the\n field selectors could be resolved\n \"\"\"\n\n prefix = self._prefix\n\n if resource:\n rfield = S3ResourceField(resource, fields)\n label = rfield.label\n else:\n label = None\n\n if \"levels\" in self.opts:\n levels = self.opts.levels\n else:\n levels = current.gis.get_location_hierarchy().keys()\n if len(current.deployment_settings.get_gis_countries()) == 1 or \\\n current.response.s3.gis.config.region_location_id:\n levels.remove(\"L0\")\n\n fields = [\"%s$%s\" % (fields, level) for level in levels]\n if resource:\n selectors = []\n for field in fields:\n try:\n rfield = S3ResourceField(resource, field)\n except (AttributeError, TypeError):\n continue\n selectors.append(prefix(rfield.selector))\n else:\n selectors = fields\n if selectors:\n return label, \"|\".join(selectors)\n else:\n return label, None\n\n # -------------------------------------------------------------------------\n @classmethod\n def _variable(cls, selector, operator):\n \"\"\"\n Construct URL query variable(s) name from a filter query\n selector and the given operator(s)\n\n @param selector: the selector\n @param operator: the operator (or tuple/list of operators)\n\n @return: the URL query variable name (or list of variable names)\n \"\"\"\n\n selectors = selector.split(\"|\")\n return [\"%s__%s\" % (selector, operator) for selector in selectors]\n\n# =============================================================================\nclass S3OptionsFilter(S3FilterWidget):\n \"\"\"\n Options filter widget\n @see: L{Configuration Options<S3FilterWidget.__init__>}\n \"\"\"\n\n _class = \"options-filter\"\n\n operator = \"belongs\"\n\n alternatives = [\"anyof\", \"contains\"]\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Render this widget as HTML helper object(s)\n\n @param resource: the resource\n @param values: the search values from the URL query\n \"\"\"\n\n attr = self._attr(resource)\n opts = self.opts\n name = attr[\"_name\"]\n\n # Get the options\n ftype, options, noopt = self._options(resource, values=values)\n if noopt:\n return SPAN(noopt, _class=\"no-options-available\")\n else:\n options = OrderedDict(options)\n\n # Any-All-Option : for many-to-many fields the user can\n # search for records containing all the options or any\n # of the options:\n if len(options) > 1 and ftype[:4] == \"list\":\n operator = opts.get(\"operator\", None)\n if operator:\n self.operator = operator\n any_all = \"\"\n else:\n operator = self.operator\n any_all = True\n\n if operator == \"anyof\":\n filter_type = \"any\"\n else:\n filter_type = \"all\"\n if operator == \"belongs\":\n operator = \"contains\"\n\n if any_all:\n # Provide a form to prompt the user to choose\n T = current.T\n any_all = DIV(T(\"Filter type\"),\n INPUT(_name=\"%s_filter\" % name,\n _id=\"%s_filter_any\" % name,\n _type=\"radio\",\n _value=\"any\",\n value=filter_type),\n LABEL(T(\"Any\"),\n _for=\"%s_filter_any\" % name),\n INPUT(_name=\"%s_filter\" % name,\n _id=\"%s_filter_all\" % name,\n _type=\"radio\",\n _value=\"all\",\n value=filter_type),\n LABEL(T(\"All\"),\n _for=\"%s_filter_all\" % name),\n _class=\"s3-options-filter-anyall\",\n )\n\n else:\n any_all = \"\"\n\n # Initialize widget\n #widget_type = opts[\"widget\"]\n # Use groupedopts widget if we specify cols, otherwise assume multiselect\n cols = opts.get(\"cols\", None)\n if cols:\n widget_class = \"groupedopts-filter-widget\"\n w = S3GroupedOptionsWidget(options = options,\n multiple = opts.get(\"multiple\", True),\n cols = cols,\n size = opts[\"size\"] or 12,\n help_field = opts[\"help_field\"],\n )\n else:\n # Default widget_type = \"multiselect\"\n widget_class = \"multiselect-filter-widget\"\n w = S3MultiSelectWidget(filter = opts.get(\"filter\", \"auto\"),\n header = opts.get(\"header\", False),\n selectedList = opts.get(\"selectedList\", 3),\n multiple = opts.get(\"multiple\", True),\n )\n\n\n # Add widget class and default class\n classes = set(attr.get(\"_class\", \"\").split()) | \\\n set((widget_class, self._class))\n attr[\"_class\"] = \" \".join(classes) if classes else None\n\n # Render the widget\n dummy_field = Storage(name=name,\n type=ftype,\n requires=IS_IN_SET(options, multiple=True))\n widget = w(dummy_field, values, **attr)\n \n return TAG[\"\"](any_all, widget)\n\n # -------------------------------------------------------------------------\n def ajax_options(self, resource):\n \"\"\"\n Method to Ajax-retrieve the current options of this widget\n\n @param resource: the S3Resource\n \"\"\"\n\n opts = self.opts\n attr = self._attr(resource)\n ftype, options, noopt = self._options(resource)\n\n if noopt:\n options = {attr[\"_id\"]: str(noopt)}\n else:\n #widget_type = opts[\"widget\"]\n # Use groupedopts widget if we specify cols, otherwise assume multiselect\n cols = opts.get(\"cols\", None)\n if cols:\n # Use the widget method to group and sort the options\n widget = S3GroupedOptionsWidget(\n options = options,\n multiple = True,\n cols = cols,\n size = opts[\"size\"] or 12,\n help_field = opts[\"help_field\"]\n )\n options = {attr[\"_id\"]:\n widget._options({\"type\": ftype}, [])}\n else:\n # Multiselect\n # Produce a simple list of tuples\n options = {attr[\"_id\"]: [(k, s3_unicode(v))\n for k, v in options]}\n\n return options\n\n # -------------------------------------------------------------------------\n def _options(self, resource, values=None):\n \"\"\"\n Helper function to retrieve the current options for this\n filter widget\n\n @param resource: the S3Resource\n \"\"\"\n\n T = current.T\n NOOPT = T(\"No options available\")\n EMPTY = T(\"None\")\n\n #attr = self.attr\n opts = self.opts\n\n # Resolve the field selector\n selector = self.field\n if isinstance(selector, (tuple, list)):\n selector = selector[0]\n\n if resource is None:\n rname = opts.get(\"resource\")\n if rname:\n resource = current.s3db.resource(rname)\n\n if resource:\n rfield = S3ResourceField(resource, selector)\n field = rfield.field\n colname = rfield.colname\n ftype = rfield.ftype\n else:\n rfield = field = colname = None\n ftype = \"string\"\n\n # Find the options\n opt_keys = []\n\n multiple = ftype[:5] == \"list:\"\n if opts.options is not None:\n # Custom dict of options {value: label} or a callable\n # returning such a dict:\n options = opts.options\n if callable(options):\n options = options()\n opt_keys = options.keys()\n\n elif resource:\n # Determine the options from the field type\n options = None\n if ftype == \"boolean\":\n opt_keys = (True, False)\n\n elif field or rfield.virtual:\n \n groupby = field if field and not multiple else None\n virtual = field is None\n\n # If the search field is a foreign key, then try to perform\n # a reverse lookup of primary IDs in the lookup table which\n # are linked to at least one record in the resource => better\n # scalability.\n rows = None\n if field:\n ktablename, key, m = s3_get_foreign_key(field, m2m=False)\n if ktablename:\n\n multiple = m\n\n ktable = current.s3db.table(ktablename)\n key_field = ktable[key]\n colname = str(key_field)\n left = None\n\n accessible_query = current.auth.s3_accessible_query\n\n # Respect the validator of the foreign key field.\n \n # Commented because questionable: We want a filter\n # option for every current field value, even if it\n # doesn't match the validator (don't we?)\n\n #requires = field.requires\n #if requires:\n #if not isinstance(requires, list):\n #requires = [requires]\n #requires = requires[0]\n #if isinstance(requires, IS_EMPTY_OR):\n #requires = requires.other\n #if isinstance(requires, IS_ONE_OF_EMPTY):\n #query, left = requires.query(ktable)\n #else:\n #query = accessible_query(\"read\", ktable)\n #query &= (key_field == field)\n \n query = (key_field == field)\n joins = rfield.join\n for tname in joins:\n query &= joins[tname]\n\n # We do not allow the user to see values only used\n # in records he's not permitted to see:\n query &= accessible_query(\"read\", resource.table)\n\n # Filter options by location?\n location_filter = opts.get(\"location_filter\")\n if location_filter and \"location_id\" in ktable:\n location = current.session.s3.location_filter\n if location:\n query &= (ktable.location_id == location)\n\n # Filter options by organisation?\n org_filter = opts.get(\"org_filter\")\n if org_filter and \"organisation_id\" in ktable:\n root_org = current.auth.root_org()\n if root_org:\n query &= ((ktable.organisation_id == root_org) | \\\n (ktable.organisation_id == None))\n #else:\n # query &= (ktable.organisation_id == None)\n \n rows = current.db(query).select(key_field,\n resource._id.min(),\n groupby=key_field,\n left=left)\n\n # If we can not perform a reverse lookup, then we need\n # to do a forward lookup of all unique values of the\n # search field from all records in the table :/ still ok,\n # but not endlessly scalable:\n if rows is None:\n rows = resource.select([selector],\n limit=None,\n orderby=field,\n groupby=groupby,\n virtual=virtual,\n as_rows=True)\n\n opt_keys = [] # Can't use set => would make orderby pointless\n if rows:\n kappend = opt_keys.append\n kextend = opt_keys.extend\n for row in rows:\n val = row[colname]\n if virtual and callable(val):\n val = val()\n if multiple or \\\n virtual and isinstance(val, (list, tuple, set)):\n kextend([v for v in val\n if v not in opt_keys])\n elif val not in opt_keys:\n kappend(val)\n\n # Make sure the selected options are in the available options\n # (not possible if we have a fixed options dict)\n if options is None and values:\n for val in values:\n if val not in opt_keys and \\\n (not isinstance(val, (int, long)) or not str(val) in opt_keys):\n opt_keys.append(val)\n\n # No options?\n if len(opt_keys) < 1 or len(opt_keys) == 1 and not opt_keys[0]:\n return (ftype, None, opts.get(\"no_opts\", NOOPT))\n\n # Represent the options\n opt_list = [] # list of tuples (key, value)\n\n # Custom represent? (otherwise fall back to field.represent)\n represent = opts.represent\n if not represent: # or ftype[:9] != \"reference\":\n represent = field.represent if field else None\n\n if options is not None:\n # Custom dict of {value:label} => use this label\n opt_list = options.items()\n\n elif callable(represent):\n # Callable representation function:\n\n if hasattr(represent, \"bulk\"):\n # S3Represent => use bulk option\n opt_dict = represent.bulk(opt_keys,\n list_type=False,\n show_link=False)\n if None in opt_keys:\n opt_dict[None] = EMPTY\n elif None in opt_dict:\n del opt_dict[None]\n if \"\" in opt_keys:\n opt_dict[\"\"] = EMPTY\n opt_list = opt_dict.items()\n\n else:\n # Simple represent function\n args = {\"show_link\": False} \\\n if \"show_link\" in represent.func_code.co_varnames else {}\n if multiple:\n repr_opt = lambda opt: opt in (None, \"\") and (opt, EMPTY) or \\\n (opt, represent([opt], **args))\n else:\n repr_opt = lambda opt: opt in (None, \"\") and (opt, EMPTY) or \\\n (opt, represent(opt, **args))\n opt_list = map(repr_opt, opt_keys)\n\n elif isinstance(represent, str) and ftype[:9] == \"reference\":\n # Represent is a string template to be fed from the\n # referenced record\n\n # Get the referenced table\n db = current.db\n ktable = db[ftype[10:]]\n\n k_id = ktable._id.name\n\n # Get the fields referenced by the string template\n fieldnames = [k_id]\n fieldnames += re.findall(\"%\\(([a-zA-Z0-9_]*)\\)s\", represent)\n represent_fields = [ktable[fieldname] for fieldname in fieldnames]\n\n # Get the referenced records\n query = (ktable.id.belongs([k for k in opt_keys\n if str(k).isdigit()])) & \\\n (ktable.deleted == False)\n rows = db(query).select(*represent_fields).as_dict(key=k_id)\n\n # Run all referenced records against the format string\n opt_list = []\n ol_append = opt_list.append\n for opt_value in opt_keys:\n if opt_value in rows:\n opt_represent = represent % rows[opt_value]\n if opt_represent:\n ol_append((opt_value, opt_represent))\n\n else:\n # Straight string representations of the values (fallback)\n opt_list = [(opt_value, s3_unicode(opt_value))\n for opt_value in opt_keys if opt_value]\n\n none = opts[\"none\"]\n\n try:\n opt_list.sort(key=lambda item: item[1])\n except:\n opt_list.sort(key=lambda item: s3_unicode(item[1]))\n options = []\n empty = False\n for k, v in opt_list:\n if k is None:\n if none:\n empty = True\n if none is True:\n # Use the represent\n options.append((k, v))\n else:\n # Must be a string to use as the represent:\n options.append((k, none))\n else:\n options.append((k, v))\n if none and not empty:\n # Add the value anyway (e.g. not found via the reverse lookup)\n if none is True:\n none = current.messages[\"NONE\"]\n options.append((None, none))\n\n # Sort the options\n return (ftype, options, None)\n\n # -------------------------------------------------------------------------\n @staticmethod\n def _values(get_vars, variable):\n \"\"\"\n Helper method to get all values of a URL query variable\n\n @param get_vars: the GET vars (a dict)\n @param variable: the name of the query variable\n\n @return: a list of values\n \"\"\"\n\n if not variable:\n return []\n\n # Match __eq before checking any other operator\n selector = variable.split(\"__\", 1)[0]\n for key in (\"%s__eq\" % selector, selector, variable):\n if key in get_vars:\n values = S3URLQuery.parse_value(get_vars[key])\n if not isinstance(values, (list, tuple)):\n values = [values]\n return values\n\n return []\n\n# =============================================================================\nclass S3HierarchyFilter(S3FilterWidget):\n \"\"\"\n Filter widget for hierarchical types\n\n Specific options:\n\n lookup name of the lookup table\n represent representation method for the key\n \"\"\"\n\n _class = \"hierarchy-filter\"\n\n operator = \"belongs\"\n\n # -------------------------------------------------------------------------\n def widget(self, resource, values):\n \"\"\"\n Render this widget as HTML helper object(s)\n\n @param resource: the resource\n @param values: the search values from the URL query\n \"\"\"\n \n # Currently selected values\n selected = []\n append = selected.append\n if not isinstance(values, (list, tuple, set)):\n values = [values]\n for v in values:\n if isinstance(v, (int, long)) or str(v).isdigit():\n append(v)\n\n # Resolve the field selector\n rfield = S3ResourceField(resource, self.field)\n\n # Instantiate the widget\n opts = self.opts\n w = S3HierarchyWidget(lookup = opts.get(\"lookup\"),\n represent = opts.get(\"represent\"),\n multiple = opts.get(\"multiple\", True),\n leafonly = opts.get(\"leafonly\", True),\n )\n\n # Render the widget\n widget = w(rfield.field, selected, **self._attr(resource))\n widget.add_class(self._class)\n\n return widget\n\n# =============================================================================\nclass S3FilterForm(object):\n \"\"\" Helper class to construct and render a filter form for a resource \"\"\"\n\n def __init__(self, widgets, **attr):\n \"\"\"\n Constructor\n\n @param widgets: the widgets (as list)\n @param attr: HTML attributes for this form\n \"\"\"\n\n self.widgets = widgets\n\n attributes = Storage()\n options = Storage()\n for k, v in attr.iteritems():\n if k[0] == \"_\":\n attributes[k] = v\n else:\n options[k] = v\n self.attr = attributes\n self.opts = options\n\n # -------------------------------------------------------------------------\n def html(self, resource, get_vars=None, target=None, alias=None):\n \"\"\"\n Render this filter form as HTML form.\n\n @param resource: the S3Resource\n @param get_vars: the request GET vars (URL query dict)\n @param target: the HTML element ID of the target object for\n this filter form (e.g. a datatable)\n @param alias: the resource alias to use in widgets\n \"\"\"\n\n attr = self.attr\n form_id = attr.get(\"_id\")\n if not form_id:\n form_id = \"filter-form\"\n attr[\"_id\"] = form_id\n\n # Prevent issues with Webkit-based browsers & Back buttons\n attr[\"_autocomplete\"] = \"off\"\n\n opts = self.opts\n settings = current.deployment_settings\n\n # Form style\n formstyle = opts.get(\"formstyle\", None)\n if not formstyle:\n formstyle = settings.get_ui_filter_formstyle()\n\n # Filter widgets\n rows = self._render_widgets(resource,\n get_vars=get_vars or {},\n alias=alias,\n formstyle=formstyle)\n\n # Other filter form controls\n controls = self._render_controls(resource)\n if controls:\n rows.append(formstyle(None, \"\", controls, \"\"))\n\n # Submit elements\n ajax = opts.get(\"ajax\", False)\n submit = opts.get(\"submit\", False)\n if submit:\n # Auto-submit?\n auto_submit = settings.get_ui_filter_auto_submit()\n if auto_submit and opts.get(\"auto_submit\", True):\n script = '''S3.search.filterFormAutoSubmit('%s',%s)''' % \\\n (form_id, auto_submit)\n current.response.s3.jquery_ready.append(script)\n\n # Custom label and class\n _class = None\n if submit is True:\n label = current.T(\"Search\")\n elif isinstance(submit, (list, tuple)):\n label, _class = submit\n else:\n label = submit\n\n # Submit button\n submit_button = INPUT(_type=\"button\",\n _value=label,\n _class=\"filter-submit\")\n #if auto_submit:\n #submit_button.add_class(\"hide\")\n if _class:\n submit_button.add_class(_class)\n\n # Where to request filtered data from:\n submit_url = opts.get(\"url\", URL(vars={}))\n \n # Where to request updated options from:\n ajax_url = opts.get(\"ajaxurl\", URL(args=[\"filter.options\"], vars={}))\n\n # Submit row elements\n submit = TAG[\"\"](submit_button,\n INPUT(_type=\"hidden\",\n _class=\"filter-ajax-url\",\n _value=ajax_url),\n INPUT(_type=\"hidden\",\n _class=\"filter-submit-url\",\n _value=submit_url))\n if ajax and target:\n submit.append(INPUT(_type=\"hidden\",\n _class=\"filter-submit-target\",\n _value=target))\n\n # Append submit row\n submit_row = formstyle(None, \"\", submit, \"\")\n if auto_submit and hasattr(submit_row, \"add_class\"):\n submit_row.add_class(\"hide\")\n rows.append(submit_row)\n\n # Filter Manager (load/apply/save filters)\n fm = settings.get_search_filter_manager()\n if fm and opts.get(\"filter_manager\", resource is not None):\n filter_manager = self._render_filters(resource, form_id)\n if filter_manager:\n fmrow = formstyle(None, \"\", filter_manager, \"\")\n if hasattr(fmrow, \"add_class\"):\n fmrow.add_class(\"hide filter-manager-row\")\n rows.append(fmrow)\n\n # Adapt to formstyle: render a TABLE only if formstyle returns TRs\n if rows:\n elements = rows[0]\n if not isinstance(elements, (list, tuple)):\n elements = elements.elements()\n n = len(elements)\n if n > 0 and elements[0].tag == \"tr\" or \\\n n > 1 and elements[0].tag == \"\" and elements[1].tag == \"tr\":\n form = FORM(TABLE(TBODY(rows)), **attr)\n else:\n form = FORM(DIV(rows), **attr)\n if settings.ui.formstyle == \"bootstrap\":\n # We need to amend the HTML markup to support this CSS framework\n form.add_class(\"form-horizontal\")\n form.add_class(\"filter-form\")\n if ajax:\n form.add_class(\"filter-ajax\")\n else:\n return \"\"\n\n # Put a copy of formstyle into the form for access by the view\n form.formstyle = formstyle\n return form\n\n # -------------------------------------------------------------------------\n def fields(self, resource, get_vars=None, alias=None):\n \"\"\"\n Render the filter widgets without FORM wrapper, e.g. to\n embed them as fieldset in another form.\n\n @param resource: the S3Resource\n @param get_vars: the request GET vars (URL query dict)\n @param alias: the resource alias to use in widgets\n \"\"\"\n\n formstyle = self.opts.get(\"formstyle\", None)\n if not formstyle:\n formstyle = current.deployment_settings.get_ui_filter_formstyle()\n\n rows = self._render_widgets(resource,\n get_vars=get_vars,\n alias=alias,\n formstyle=formstyle)\n\n controls = self._render_controls(resource)\n if controls:\n rows.append(formstyle(None, \"\", controls, \"\"))\n \n # Adapt to formstyle: only render a TABLE if formstyle returns TRs\n if rows:\n elements = rows[0]\n if not isinstance(elements, (list, tuple)):\n elements = elements.elements()\n n = len(elements)\n if n > 0 and elements[0].tag == \"tr\" or \\\n n > 1 and elements[0].tag == \"\" and elements[1].tag == \"tr\":\n fields = TABLE(TBODY(rows))\n else:\n fields = DIV(rows)\n\n return fields\n\n # -------------------------------------------------------------------------\n def _render_controls(self, resource):\n \"\"\"\n Render optional additional filter form controls: advanced\n options toggle, clear filters.\n \"\"\"\n\n T = current.T\n controls = []\n opts = self.opts\n \n advanced = opts.get(\"advanced\", False)\n if advanced:\n _class = \"filter-advanced\"\n if advanced is True:\n label = T(\"More Options\")\n elif isinstance(advanced, (list, tuple)):\n label = advanced[0]\n label = advanced[1]\n if len(advanced > 2):\n _class = \"%s %s\" % (advanced[2], _class)\n else:\n label = advanced\n label_off = T(\"Less Options\")\n advanced = A(SPAN(label,\n data = {\"on\": label,\n \"off\": label_off,\n },\n _class=\"filter-advanced-label\",\n ),\n I(\" \", _class=\"icon-down\"),\n I(\" \", _class=\"icon-up\", _style=\"display:none\"),\n _class=_class\n )\n controls.append(advanced)\n\n clear = opts.get(\"clear\", True)\n if clear:\n _class = \"filter-clear\"\n if clear is True:\n label = T(\"Clear filter\")\n elif isinstance(clear, (list, tuple)):\n label = clear[0]\n _class = \"%s %s\" % (clear[1], _class)\n else:\n label = clear\n clear = A(label, _class=_class)\n clear.add_class(\"action-lnk\")\n controls.append(clear)\n\n fm = current.deployment_settings.get_search_filter_manager()\n if fm and opts.get(\"filter_manager\", resource is not None):\n show_fm = A(T(\"Saved filters\"),\n _class=\"show-filter-manager action-lnk\")\n controls.append(show_fm)\n\n if controls:\n return DIV(controls, _class=\"filter-controls\")\n else:\n return None\n\n # -------------------------------------------------------------------------\n def _render_widgets(self,\n resource,\n get_vars=None,\n alias=None,\n formstyle=None):\n \"\"\"\n Render the filter widgets\n \n @param resource: the S3Resource\n @param get_vars: the request GET vars (URL query dict)\n @param alias: the resource alias to use in widgets\n @param formstyle: the formstyle to use\n\n @return: a list of form rows\n \"\"\"\n \n rows = []\n rappend = rows.append\n advanced = False\n for f in self.widgets:\n widget = f(resource, get_vars, alias=alias)\n label = f.opts[\"label\"]\n comment = f.opts[\"comment\"]\n hidden = f.opts[\"hidden\"]\n if hidden:\n advanced = True\n widget_id = f.attr[\"_id\"]\n if widget_id:\n row_id = \"%s__row\" % widget_id\n label_id = \"%s__label\" % widget_id\n else:\n row_id = None\n label_id = None\n if label:\n label = LABEL(\"%s:\" % label, _id=label_id, _for=widget_id)\n else:\n label = \"\"\n if not comment:\n comment = \"\"\n formrow = formstyle(row_id, label, widget, comment, hidden=hidden)\n if hidden:\n if isinstance(formrow, DIV):\n formrow.add_class(\"advanced\")\n elif isinstance(formrow, tuple):\n for item in formrow:\n if hasattr(item, \"add_class\"):\n item.add_class(\"advanced\")\n rappend(formrow)\n if advanced:\n if resource:\n self.opts[\"advanced\"] = resource.get_config(\n \"filter_advanced\", True)\n else:\n self.opts[\"advanced\"] = True\n return rows\n \n # -------------------------------------------------------------------------\n def _render_filters(self, resource, form_id):\n \"\"\"\n Render a filter manager widget\n\n @param resource: the resource\n @return: the widget\n \"\"\"\n\n SELECT_FILTER = current.T(\"Saved Filters...\")\n\n ajaxurl = self.opts.get(\"saveurl\", URL(args=[\"filter.json\"], vars={}))\n \n # Current user\n auth = current.auth\n pe_id = auth.user.pe_id if auth.s3_logged_in() else None\n if not pe_id:\n return None\n \n table = current.s3db.pr_filter\n query = (table.deleted != True) & \\\n (table.pe_id == pe_id)\n\n if resource:\n query &= (table.resource == resource.tablename)\n else:\n query &= (table.resource == None)\n\n rows = current.db(query).select(table._id,\n table.title,\n table.query,\n orderby=table.title)\n \n options = [OPTION(SELECT_FILTER,\n _value=\"\",\n _class=\"filter-manager-prompt\",\n _disabled=\"disabled\")]\n add_option = options.append\n filters = {}\n for row in rows:\n filter_id = row[table._id]\n add_option(OPTION(row.title, _value=filter_id))\n query = row.query\n if query:\n query = json.loads(query)\n filters[filter_id] = query\n widget_id = \"%s-fm\" % form_id\n widget = DIV(SELECT(options,\n _id=widget_id,\n _class=\"filter-manager-widget\"),\n _class=\"filter-manager-container\")\n\n # JSON-serializable translator\n T = current.T\n _t = lambda s: str(T(s))\n\n # Configure the widget\n settings = current.deployment_settings\n config = dict(\n\n # Filters and Ajax URL\n filters = filters,\n ajaxURL = ajaxurl,\n\n # Workflow Options\n allowDelete = settings.get_search_filter_manager_allow_delete(),\n\n # Tooltips for action icons/buttons\n createTooltip = _t(\"Save current options as new filter\"),\n loadTooltip = _t(\"Load filter\"),\n saveTooltip = _t(\"Update saved filter\"),\n deleteTooltip = _t(\"Delete saved filter\"),\n\n # Hints\n titleHint = _t(\"Enter a title...\"),\n selectHint = str(SELECT_FILTER),\n emptyHint = _t(\"No saved filters\"),\n\n # Confirm update + confirmation text\n confirmUpdate = _t(\"Update this filter?\"),\n confirmDelete = _t(\"Delete this filter?\"),\n )\n\n # Render actions as buttons with text if configured, otherwise\n # they will appear as empty DIVs with classes for CSS icons\n create_text = settings.get_search_filter_manager_save()\n if create_text:\n config[\"createText\"] = _t(create_text)\n update_text = settings.get_search_filter_manager_update()\n if update_text:\n config[\"saveText\"] = _t(update_text)\n delete_text = settings.get_search_filter_manager_delete()\n if delete_text:\n config[\"deleteText\"] = _t(delete_text)\n load_text = settings.get_search_filter_manager_load()\n if load_text:\n config[\"loadText\"] = _t(load_text)\n \n script = '''$(\"#%s\").filtermanager(%s)''' % \\\n (widget_id,\n json.dumps(config, separators=SEPARATORS))\n\n current.response.s3.jquery_ready.append(script)\n\n return widget\n\n # -------------------------------------------------------------------------\n def json(self, resource, get_vars=None):\n \"\"\"\n Render this filter form as JSON (for Ajax requests)\n\n @param resource: the S3Resource\n @param get_vars: the request GET vars (URL query dict)\n \"\"\"\n\n raise NotImplementedError\n\n # -------------------------------------------------------------------------\n @staticmethod\n def apply_filter_defaults(request, resource):\n \"\"\"\n Add default filters to resource, to be called a multi-record\n view with a filter form is rendered the first time and before\n the view elements get processed\n\n @param request: the request\n @param resource: the resource\n \"\"\"\n\n s3 = current.response.s3\n\n get_vars = request.get_vars\n tablename = resource.tablename\n\n # Do we have filter defaults for this resource?\n filter_defaults = s3\n for level in (\"filter_defaults\", tablename):\n if level not in filter_defaults:\n return None\n filter_defaults = filter_defaults[level]\n\n # Which filter widgets do we need to apply defaults for?\n filter_widgets = resource.get_config(\"filter_widgets\")\n for filter_widget in filter_widgets:\n # Do not apply defaults of hidden widgets because they are\n # not visible to the user:\n if filter_widget.opts.hidden:\n continue\n\n defaults = {}\n variable = filter_widget.variable(resource, get_vars)\n\n # Do we have a corresponding value in get_vars?\n if type(variable) is list:\n for k in variable:\n values = filter_widget._values(get_vars, k)\n if values:\n filter_widget.values[k] = values\n else:\n defaults[k] = None\n else:\n values = filter_widget._values(get_vars, variable)\n if values:\n filter_widget.values[variable] = values\n else:\n defaults[variable] = None\n\n default_filters = {}\n for variable in defaults:\n if \"__\" in variable:\n selector, operator = variable.split(\"__\", 1)\n else:\n selector, operator = variable, None\n if selector not in filter_defaults:\n continue\n applicable_defaults = filter_defaults[selector]\n if callable(applicable_defaults):\n applicable_defaults = applicable_defaults(selector,\n tablename=tablename)\n if isinstance(applicable_defaults, dict):\n if operator in applicable_defaults:\n default = applicable_defaults[operator]\n else:\n continue\n elif operator in (None, \"belongs\", \"eq\"):\n default = applicable_defaults\n else:\n continue\n if not isinstance(default, (list, type(None))):\n default = [default]\n filter_widget.values[variable] = [str(v) if v is None else v\n for v in default]\n default_filters[variable] = \",\".join(s3_unicode(v)\n for v in default)\n\n # @todo: make sure the applied default options are available in\n # the filter widget - otherwise the user can not deselect\n # them! (critical) Maybe enforce this by adding the default\n # values to the available options in S3OptionsFilter and\n # S3LocationFilter?\n\n # Apply to resource\n queries = S3URLQuery.parse(resource, default_filters)\n add_filter = resource.add_filter\n for alias in queries:\n for q in queries[alias]:\n add_filter(q)\n \n return\n\n# =============================================================================\nclass S3Filter(S3Method):\n \"\"\" Back-end for filter forms \"\"\"\n\n def apply_method(self, r, **attr):\n \"\"\"\n Entry point for REST interface\n\n @param r: the S3Request\n @param attr: additional controller parameters\n \"\"\"\n\n representation = r.representation\n if representation == \"options\":\n # Return the filter options as JSON\n return self._options(r, **attr)\n\n elif representation == \"json\":\n if r.http == \"GET\":\n # Load list of saved filters\n return self._load(r, **attr)\n elif r.http == \"POST\":\n if \"delete\" in r.get_vars:\n # Delete a filter\n return self._delete(r, **attr)\n else:\n # Save a filter\n return self._save(r, **attr)\n else:\n r.error(405, current.ERROR.BAD_METHOD)\n \n elif representation == \"html\":\n return self._form(r, **attr)\n\n else:\n r.error(501, current.ERROR.BAD_FORMAT)\n\n # -------------------------------------------------------------------------\n def _form(self, r, **attr):\n \"\"\"\n Get the filter form for the target resource as HTML snippet\n\n GET filter.html\n\n @param r: the S3Request\n @param attr: additional controller parameters\n \"\"\"\n\n r.error(501, current.ERROR.NOT_IMPLEMENTED)\n\n # -------------------------------------------------------------------------\n def _options(self, r, **attr):\n \"\"\"\n Get the updated options for the filter form for the target\n resource as JSON\n\n GET filter.options\n\n @param r: the S3Request\n @param attr: additional controller parameters\n \"\"\"\n\n resource = self.resource\n get_config = resource.get_config\n\n options = {}\n\n filter_widgets = get_config(\"filter_widgets\", None)\n if filter_widgets:\n fresource = current.s3db.resource(resource.tablename)\n\n for widget in filter_widgets:\n if hasattr(widget, \"ajax_options\"):\n opts = widget.ajax_options(fresource)\n if opts and isinstance(opts, dict):\n options.update(opts)\n\n options = json.dumps(options, separators=SEPARATORS)\n current.response.headers[\"Content-Type\"] = \"application/json\"\n return options\n\n # -------------------------------------------------------------------------\n def _delete(self, r, **attr):\n \"\"\"\n Delete a filter, responds to POST filter.json?delete=\n \n @param r: the S3Request\n @param attr: additional controller parameters\n \"\"\"\n \n # Authorization, get pe_id\n auth = current.auth\n if auth.s3_logged_in():\n pe_id = current.auth.user.pe_id\n else:\n pe_id = None\n if not pe_id:\n r.unauthorised()\n\n # Read the source\n source = r.body\n source.seek(0)\n\n try:\n data = json.load(source)\n except ValueError:\n # Syntax error: no JSON data\n r.error(501, current.ERROR.BAD_SOURCE)\n\n # Try to find the record\n db = current.db\n s3db = current.s3db\n\n table = s3db.pr_filter\n record = None\n record_id = data.get(\"id\")\n if record_id:\n query = (table.id == record_id) & (table.pe_id == pe_id)\n record = db(query).select(table.id, limitby=(0, 1)).first()\n if not record:\n r.error(501, current.ERROR.BAD_RECORD)\n \n resource = s3db.resource(\"pr_filter\", id=record_id)\n success = resource.delete(format=r.representation)\n\n if not success:\n raise(400, resource.error)\n else:\n current.response.headers[\"Content-Type\"] = \"application/json\"\n return current.xml.json_message(deleted=record_id)\n\n # -------------------------------------------------------------------------\n def _save(self, r, **attr):\n \"\"\"\n Save a filter, responds to POST filter.json\n \n @param r: the S3Request\n @param attr: additional controller parameters\n \"\"\"\n\n # Authorization, get pe_id\n auth = current.auth\n if auth.s3_logged_in():\n pe_id = current.auth.user.pe_id\n else:\n pe_id = None\n if not pe_id:\n r.unauthorised()\n\n # Read the source\n source = r.body\n source.seek(0)\n\n try:\n data = json.load(source)\n except ValueError:\n r.error(501, current.ERROR.BAD_SOURCE)\n\n # Try to find the record\n db = current.db\n s3db = current.s3db\n \n table = s3db.pr_filter\n record_id = data.get(\"id\")\n record = None\n if record_id:\n query = (table.id == record_id) & (table.pe_id == pe_id)\n record = db(query).select(table.id, limitby=(0, 1)).first()\n if not record:\n r.error(404, current.ERROR.BAD_RECORD)\n\n # Build new record\n filter_data = {\n \"pe_id\": pe_id,\n \"controller\": r.controller,\n \"function\": r.function,\n \"resource\": self.resource.tablename,\n \"deleted\": False,\n }\n\n title = data.get(\"title\")\n if title is not None:\n filter_data[\"title\"] = title\n\n description = data.get(\"description\")\n if description is not None:\n filter_data[\"description\"] = description\n\n query = data.get(\"query\")\n if query is not None:\n filter_data[\"query\"] = json.dumps(query)\n\n url = data.get(\"url\")\n if url is not None:\n filter_data[\"url\"] = url\n\n # Store record\n onaccept = None\n form = Storage(vars=filter_data)\n if record:\n success = db(table.id == record_id).update(**filter_data)\n if success:\n current.audit(\"update\", \"pr\", \"filter\", form, record_id, \"json\")\n info = {\"updated\": record_id}\n onaccept = s3db.get_config(table, \"update_onaccept\",\n s3db.get_config(table, \"onaccept\"))\n else:\n success = table.insert(**filter_data)\n if success:\n record_id = success\n current.audit(\"create\", \"pr\", \"filter\", form, record_id, \"json\")\n info = {\"created\": record_id}\n onaccept = s3db.get_config(table, \"update_onaccept\",\n s3db.get_config(table, \"onaccept\"))\n\n if onaccept is not None:\n form.vars[\"id\"] = record_id\n callback(onaccept, form)\n\n # Success/Error response\n xml = current.xml\n if success:\n msg = xml.json_message(**info)\n else:\n msg = xml.json_message(False, 400)\n current.response.headers[\"Content-Type\"] = \"application/json\"\n return msg\n\n # -------------------------------------------------------------------------\n def _load(self, r, **attr):\n \"\"\"\n Load filters\n\n GET filter.json or GET filter.json?load=<id>\n \n @param r: the S3Request\n @param attr: additional controller parameters\n \"\"\"\n\n db = current.db\n table = current.s3db.pr_filter\n\n # Authorization, get pe_id\n auth = current.auth\n if auth.s3_logged_in():\n pe_id = current.auth.user.pe_id\n else:\n pe_id = None\n if not pe_id:\n r.unauthorized()\n\n # Build query\n query = (table.deleted != True) & \\\n (table.resource == self.resource.tablename) & \\\n (table.pe_id == pe_id)\n\n # Any particular filters?\n load = r.get_vars.get(\"load\")\n if load:\n record_ids = [i for i in load.split(\",\") if i.isdigit()]\n if record_ids:\n if len(record_ids) > 1:\n query &= table.id.belongs(record_ids)\n else:\n query &= table.id == record_ids[0]\n else:\n record_ids = None\n\n # Retrieve filters\n rows = db(query).select(table.id,\n table.title,\n table.description,\n table.query)\n\n # Pack filters\n filters = []\n for row in rows:\n filters.append({\n \"id\": row.id,\n \"title\": row.title,\n \"description\": row.description,\n \"query\": json.loads(row.query) if row.query else [],\n })\n\n # JSON response\n current.response.headers[\"Content-Type\"] = \"application/json\"\n return json.dumps(filters, separators=SEPARATORS)\n\n# =============================================================================\nclass S3FilterString(object):\n \"\"\"\n Helper class to render a human-readable representation of a\n filter query, as representation method of JSON-serialized\n queries in saved filters.\n \"\"\"\n\n def __init__(self, resource, query):\n \"\"\"\n Constructor\n\n @param query: the URL query (list of key-value pairs or a\n string with such a list in JSON)\n \"\"\"\n\n if type(query) is not list:\n try:\n self.query = json.loads(query)\n except ValueError:\n self.query = []\n else:\n self.query = query\n\n get_vars = {}\n for k, v in self.query:\n if v is not None:\n key = resource.prefix_selector(k)\n if key in get_vars:\n value = get_vars[key]\n if type(value) is list:\n value.append(v)\n else:\n get_vars[key] = [value, v]\n else:\n get_vars[key] = v\n\n self.resource = resource\n self.get_vars = get_vars\n\n # -------------------------------------------------------------------------\n def represent(self):\n \"\"\" Render the query representation for the given resource \"\"\"\n\n default = \"\"\n\n get_vars = self.get_vars\n resource = self.resource\n if not get_vars:\n return default\n else:\n queries = S3URLQuery.parse(resource, get_vars)\n\n # Get alternative field labels\n labels = {}\n get_config = resource.get_config\n prefix = resource.prefix_selector\n for config in (\"list_fields\", \"notify_fields\"):\n fields = get_config(config, set())\n for f in fields:\n if type(f) is tuple:\n labels[prefix(f[1])] = f[0]\n\n # Iterate over the sub-queries\n render = self._render\n substrings = []\n append = substrings.append\n for alias, subqueries in queries.iteritems():\n\n for subquery in subqueries:\n s = render(resource, alias, subquery, labels=labels)\n if s:\n append(s)\n\n if substrings:\n result = substrings[0]\n T = current.T\n for s in substrings[1:]:\n result = T(\"%s AND %s\") % (result, s)\n return result\n else:\n return default\n\n # -------------------------------------------------------------------------\n @classmethod\n def _render(cls, resource, alias, query, invert=False, labels=None):\n \"\"\"\n Recursively render a human-readable representation of a\n S3ResourceQuery.\n\n @param resource: the S3Resource\n @param query: the S3ResourceQuery\n @param invert: invert the query\n \"\"\"\n\n T = current.T\n\n if not query:\n return None\n\n op = query.op\n\n l = query.left\n r = query.right\n render = lambda q, r=resource, a=alias, invert=False, labels=labels: \\\n cls._render(r, a, q, invert=invert, labels=labels)\n\n if op == query.AND:\n # Recurse AND\n l = render(l)\n r = render(r)\n if l is not None and r is not None:\n if invert:\n result = T(\"NOT %s OR NOT %s\") % (l, r)\n else:\n result = T(\"%s AND %s\") % (l, r)\n else:\n result = l if l is not None else r\n elif op == query.OR:\n # Recurse OR\n l = render(l)\n r = render(r)\n if l is not None and r is not None:\n if invert:\n result = T(\"NOT %s AND NOT %s\") % (l, r)\n else:\n result = T(\"%s OR %s\") % (l, r)\n else:\n result = l if l is not None else r\n elif op == query.NOT:\n # Recurse NOT\n result = render(l, invert=not invert)\n else:\n # Resolve the field selector against the resource\n try:\n rfield = l.resolve(resource)\n except (AttributeError, SyntaxError):\n return None\n\n # Convert the filter values into the field type\n try:\n values = cls._convert(rfield, r)\n except (TypeError, ValueError):\n values = r\n\n # Alias\n selector = l.name\n if labels and selector in labels:\n rfield.label = labels[selector]\n # @todo: for duplicate labels, show the table name\n #else:\n #tlabel = \" \".join(s.capitalize() for s in rfield.tname.split(\"_\")[1:])\n #rfield.label = \"(%s) %s\" % (tlabel, rfield.label)\n\n # Represent the values\n if values is None:\n values = T(\"None\")\n else:\n list_type = rfield.ftype[:5] == \"list:\"\n renderer = rfield.represent\n if not callable(renderer):\n renderer = lambda v: s3_unicode(v)\n if hasattr(renderer, \"linkto\"):\n #linkto = renderer.linkto\n renderer.linkto = None\n #else:\n # #linkto = None\n\n is_list = type(values) is list\n\n try:\n if is_list and hasattr(renderer, \"bulk\") and not list_type:\n fvalues = renderer.bulk(values, list_type=False)\n values = [fvalues[v] for v in values if v in fvalues]\n elif list_type:\n if is_list:\n values = renderer(values)\n else:\n values = renderer([values])\n else:\n if is_list:\n values = [renderer(v) for v in values]\n else:\n values = renderer(values)\n except:\n values = s3_unicode(values)\n\n # Translate the query\n result = cls._translate_query(query, rfield, values, invert=invert)\n\n return result\n\n # -------------------------------------------------------------------------\n @classmethod\n def _convert(cls, rfield, value):\n \"\"\"\n Convert a filter value according to the field type\n before representation\n\n @param rfield: the S3ResourceField\n @param value: the value\n \"\"\"\n\n if value is None:\n return value\n\n ftype = rfield.ftype\n if ftype[:5] == \"list:\":\n if ftype[5:8] in (\"int\", \"ref\"):\n ftype = long\n else:\n ftype = unicode\n elif ftype == \"id\" or ftype [:9] == \"reference\":\n ftype = long\n elif ftype == \"integer\":\n ftype = int\n elif ftype == \"date\":\n ftype = datetime.date\n elif ftype == \"time\":\n ftype = datetime.time\n elif ftype == \"datetime\":\n ftype = datetime.datetime\n elif ftype == \"double\":\n ftype = float\n elif ftype == \"boolean\":\n ftype = bool\n else:\n ftype = unicode\n\n convert = S3TypeConverter.convert\n if type(value) is list:\n output = []\n append = output.append\n for v in value:\n try:\n append(convert(ftype, v))\n except TypeError, ValueError:\n continue\n else:\n try:\n output = convert(ftype, value)\n except TypeError, ValueError:\n output = None\n return output\n\n # -------------------------------------------------------------------------\n @classmethod\n def _translate_query(cls, query, rfield, values, invert=False):\n \"\"\"\n Translate the filter query into human-readable language\n\n @param query: the S3ResourceQuery\n @param rfield: the S3ResourceField the query refers to\n @param values: the filter values\n @param invert: invert the operation\n \"\"\"\n\n T = current.T\n\n # Value list templates\n vor = T(\"%s or %s\")\n vand = T(\"%s and %s\")\n\n # Operator templates\n otemplates = {\n query.LT: (query.GE, vand, \"%(label)s < %(values)s\"),\n query.LE: (query.GT, vand, \"%(label)s <= %(values)s\"),\n query.EQ: (query.NE, vor, T(\"%(label)s is %(values)s\")),\n query.GE: (query.LT, vand, \"%(label)s >= %(values)s\"),\n query.GT: (query.LE, vand, \"%(label)s > %(values)s\"),\n query.NE: (query.EQ, vor, T(\"%(label)s != %(values)s\")),\n query.LIKE: (\"notlike\", vor, T(\"%(label)s like %(values)s\")),\n query.BELONGS: (query.NE, vor, T(\"%(label)s = %(values)s\")),\n query.CONTAINS: (\"notall\", vand, T(\"%(label)s contains %(values)s\")),\n query.ANYOF: (\"notany\", vor, T(\"%(label)s contains any of %(values)s\")),\n \"notall\": (query.CONTAINS, vand, T(\"%(label)s does not contain %(values)s\")),\n \"notany\": (query.ANYOF, vor, T(\"%(label)s does not contain %(values)s\")),\n \"notlike\": (query.LIKE, vor, T(\"%(label)s not like %(values)s\"))\n }\n\n # Quote values as necessary\n ftype = rfield.ftype\n if ftype in (\"string\", \"text\") or \\\n ftype[:9] == \"reference\" or \\\n ftype[:5] == \"list:\" and ftype[5:8] in (\"str\", \"ref\"):\n if type(values) is list:\n values = ['\"%s\"' % v for v in values]\n elif values is not None:\n values = '\"%s\"' % values\n else:\n values = current.messages[\"NONE\"]\n\n # Render value list template\n def render_values(template=None, values=None):\n if not template or type(values) is not list:\n return str(values)\n elif not values:\n return \"()\"\n elif len(values) == 1:\n return values[0]\n else:\n return template % (\", \".join(values[:-1]), values[-1])\n\n # Render the operator template\n op = query.op\n if op in otemplates:\n inversion, vtemplate, otemplate = otemplates[op]\n if invert:\n inversion, vtemplate, otemplate = otemplates[inversion]\n return otemplate % dict(label=rfield.label,\n values=render_values(vtemplate, values))\n else:\n # Fallback to simple representation\n # FIXME: resource not defined here!\n return query.represent(resource)\n\n# END =========================================================================\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227994,"cells":{"text":{"kind":"string","value":"import copy\nfrom direct.controls.GravityWalker import GravityWalker\nfrom direct.directnotify import DirectNotifyGlobal\nfrom direct.distributed import DistributedObject\nfrom direct.distributed import DistributedSmoothNode\nfrom direct.distributed.ClockDelta import *\nfrom direct.distributed.MsgTypes import *\nfrom direct.fsm import ClassicFSM\nfrom direct.interval.IntervalGlobal import Sequence, Wait, Func, Parallel, SoundInterval\nfrom direct.showbase import PythonUtil\nfrom direct.task.Task import Task\nimport operator\nfrom pandac.PandaModules import *\nimport random\nimport time\n\nimport Experience\nimport InventoryNew\nimport TTEmote\nimport Toon\nfrom otp.ai.MagicWordGlobal import *\nfrom otp.avatar import Avatar, DistributedAvatar\nfrom otp.avatar import DistributedPlayer\nfrom otp.chat import TalkAssistant\nfrom otp.otpbase import OTPGlobals\nfrom otp.otpbase import OTPLocalizer\nfrom otp.speedchat import SCDecoders\nfrom toontown.catalog import CatalogItem\nfrom toontown.catalog import CatalogItemList\nfrom toontown.chat import ResistanceChat\nfrom toontown.chat import ToonChatGarbler\nfrom toontown.chat.ChatGlobals import *\nfrom toontown.chat.WhisperPopup import *\nfrom toontown.coghq import CogDisguiseGlobals\nfrom toontown.distributed import DelayDelete\nfrom toontown.distributed import DelayDelete\nfrom toontown.distributed.DelayDeletable import DelayDeletable\nfrom toontown.effects.ScavengerHuntEffects import *\nfrom toontown.estate import DistributedGagTree\nfrom toontown.estate import FlowerBasket\nfrom toontown.estate import FlowerCollection\nfrom toontown.estate import GardenDropGame\nfrom toontown.estate import GardenGlobals\nfrom toontown.fishing import FishCollection\nfrom toontown.fishing import FishTank\nfrom toontown.friends import FriendHandle\nfrom toontown.golf import GolfGlobals\nfrom toontown.hood import ZoneUtil\nfrom toontown.nametag import NametagGlobals\nfrom toontown.nametag.NametagGlobals import *\nfrom toontown.parties import PartyGlobals\nfrom toontown.parties.InviteInfo import InviteInfo\nfrom toontown.parties.PartyGlobals import InviteStatus, PartyStatus\nfrom toontown.parties.PartyInfo import PartyInfo\nfrom toontown.parties.PartyReplyInfo import PartyReplyInfoBase\nfrom toontown.parties.SimpleMailBase import SimpleMailBase\nfrom toontown.shtiker.OptionsPage import speedChatStyles\nfrom toontown.speedchat import TTSCDecoders\nfrom toontown.suit import SuitDNA\nfrom toontown.toonbase import TTLocalizer\nfrom toontown.toonbase import ToontownGlobals\n\n\nif base.wantKarts:\n from toontown.racing.KartDNA import *\nif (__debug__):\n import pdb\n\n\nclass DistributedToon(DistributedPlayer.DistributedPlayer, Toon.Toon, DistributedSmoothNode.DistributedSmoothNode, DelayDeletable):\n notify = DirectNotifyGlobal.directNotify.newCategory('DistributedToon')\n partyNotify = DirectNotifyGlobal.directNotify.newCategory('DistributedToon_Party')\n chatGarbler = ToonChatGarbler.ToonChatGarbler()\n gmNameTag = None\n\n def __init__(self, cr, bFake = False):\n try:\n self.DistributedToon_initialized\n return\n except:\n self.DistributedToon_initialized = 1\n\n DistributedPlayer.DistributedPlayer.__init__(self, cr)\n Toon.Toon.__init__(self)\n DistributedSmoothNode.DistributedSmoothNode.__init__(self, cr)\n self.bFake = bFake\n self.kart = None\n self._isGM = False\n self._gmType = None\n self.trophyScore = 0\n self.trophyStar = None\n self.trophyStarSpeed = 0\n self.safeZonesVisited = []\n self.NPCFriendsDict = {}\n self.earnedExperience = None\n self.track = None\n self.effect = None\n self.maxCarry = 0\n self.disguisePageFlag = 0\n self.sosPageFlag = 0\n self.disguisePage = None\n self.sosPage = None\n self.gardenPage = None\n self.cogTypes = [0, 0, 0, 0]\n self.cogLevels = [0, 0, 0, 0]\n self.cogParts = [0, 0, 0, 0]\n self.cogMerits = [0, 0, 0, 0]\n self.savedCheesyEffect = ToontownGlobals.CENormal\n self.savedCheesyHoodId = 0\n self.savedCheesyExpireTime = 0\n if hasattr(base, 'wantPets') and base.wantPets:\n self.petTrickPhrases = []\n self.petDNA = None\n self.customMessages = []\n self.resistanceMessages = []\n self.cogSummonsEarned = []\n self.catalogNotify = ToontownGlobals.NoItems\n self.mailboxNotify = ToontownGlobals.NoItems\n self.simpleMailNotify = ToontownGlobals.NoItems\n self.inviteMailNotify = ToontownGlobals.NoItems\n self.catalogScheduleCurrentWeek = 0\n self.catalogScheduleNextTime = 0\n self.monthlyCatalog = CatalogItemList.CatalogItemList()\n self.weeklyCatalog = CatalogItemList.CatalogItemList()\n self.backCatalog = CatalogItemList.CatalogItemList()\n self.onOrder = CatalogItemList.CatalogItemList(store=CatalogItem.Customization | CatalogItem.DeliveryDate)\n self.onGiftOrder = CatalogItemList.CatalogItemList(store=CatalogItem.Customization | CatalogItem.DeliveryDate)\n self.mailboxContents = CatalogItemList.CatalogItemList(store=CatalogItem.Customization)\n self.deliveryboxContentsContents = CatalogItemList.CatalogItemList(store=CatalogItem.Customization | CatalogItem.GiftTag)\n self.awardMailboxContents = CatalogItemList.CatalogItemList(store=CatalogItem.Customization)\n self.onAwardOrder = CatalogItemList.CatalogItemList(store=CatalogItem.Customization | CatalogItem.DeliveryDate)\n self.splash = None\n self.tossTrack = None\n self.pieTracks = {}\n self.splatTracks = {}\n self.lastTossedPie = 0\n self.clothesTopsList = []\n self.clothesBottomsList = []\n self.hatList = []\n self.glassesList = []\n self.backpackList = []\n self.shoesList = []\n self.tunnelTrack = None\n self.tunnelPivotPos = [-14, -6, 0]\n self.tunnelCenterOffset = 9.0\n self.tunnelCenterInfluence = 0.6\n self.pivotAngle = 90 + 45\n self.posIndex = 0\n self.houseId = 0\n self.money = 0\n self.bankMoney = 0\n self.maxMoney = 10000\n self.maxBankMoney = 0\n self.emblems = [0, 0]\n self.maxNPCFriends = 16\n self.petId = 0\n self.bPetTutorialDone = False\n self.bFishBingoTutorialDone = False\n self.bFishBingoMarkTutorialDone = False\n self.accessories = []\n if base.wantKarts:\n self.kartDNA = [-1] * getNumFields()\n self.flowerCollection = None\n self.shovel = 0\n self.shovelSkill = 0\n self.shovelModel = None\n self.wateringCan = 0\n self.wateringCanSkill = 0\n self.wateringCanModel = None\n self.gardenSpecials = []\n self.unlimitedSwing = 0\n self.soundSequenceList = []\n self.boardingParty = None\n self.__currentDialogue = None\n self.mail = None\n self.invites = []\n self.hostedParties = []\n self.partiesInvitedTo = []\n self.partyReplyInfoBases = []\n self.gmState = 0\n self.gmNameTagEnabled = 0\n self.gmNameTagColor = 'whiteGM'\n self.gmNameTagString = ''\n self.achievements = []\n self.canEarnAchievements = False\n self.promotionStatus = [0, 0, 0, 0]\n self.buffs = []\n\n def disable(self):\n for soundSequence in self.soundSequenceList:\n soundSequence.finish()\n\n self.soundSequenceList = []\n if self.boardingParty:\n self.boardingParty.demandDrop()\n self.boardingParty = None\n self.ignore('clientCleanup')\n self.stopAnimations()\n self.clearCheesyEffect()\n self.stopBlink()\n self.stopSmooth()\n self.stopLookAroundNow()\n self.setGhostMode(0)\n if self.track != None:\n self.track.finish()\n DelayDelete.cleanupDelayDeletes(self.track)\n self.track = None\n if self.effect != None:\n self.effect.destroy()\n self.effect = None\n if self.splash != None:\n self.splash.destroy()\n self.splash = None\n if self.emote != None:\n self.emote.finish()\n self.emote = None\n self.cleanupPies()\n if self.isDisguised:\n self.takeOffSuit()\n if self.tunnelTrack:\n self.tunnelTrack.finish()\n self.tunnelTrack = None\n self.setTrophyScore(0)\n self.removeGMIcon()\n if self.doId in self.cr.toons:\n del self.cr.toons[self.doId]\n DistributedPlayer.DistributedPlayer.disable(self)\n return\n\n def delete(self):\n try:\n self.DistributedToon_deleted\n except:\n self.DistributedToon_deleted = 1\n del self.safeZonesVisited\n DistributedPlayer.DistributedPlayer.delete(self)\n Toon.Toon.delete(self)\n DistributedSmoothNode.DistributedSmoothNode.delete(self)\n\n def generate(self):\n DistributedPlayer.DistributedPlayer.generate(self)\n DistributedSmoothNode.DistributedSmoothNode.generate(self)\n self.cr.toons[self.doId] = self\n if base.cr.trophyManager != None:\n base.cr.trophyManager.d_requestTrophyScore()\n self.startBlink()\n self.startSmooth()\n self.accept('clientCleanup', self._handleClientCleanup)\n return\n\n def announceGenerate(self):\n DistributedPlayer.DistributedPlayer.announceGenerate(self)\n if self.animFSM.getCurrentState().getName() == 'off':\n self.setAnimState('neutral')\n\n def _handleClientCleanup(self):\n if self.track != None:\n DelayDelete.cleanupDelayDeletes(self.track)\n\n def setDNAString(self, dnaString):\n Toon.Toon.setDNAString(self, dnaString)\n\n def setDNA(self, dna):\n if base.cr.newsManager:\n if base.cr.newsManager.isHolidayRunning(ToontownGlobals.SPOOKY_BLACK_CAT):\n black = 26\n heads = ['cls',\n 'css',\n 'csl',\n 'cll']\n dna.setTemporary(random.choice(heads), black, black, black)\n else:\n dna.restoreTemporary(self.style)\n oldHat = self.getHat()\n oldGlasses = self.getGlasses()\n oldBackpack = self.getBackpack()\n oldShoes = self.getShoes()\n self.setHat(0, 0, 0)\n self.setGlasses(0, 0, 0)\n self.setBackpack(0, 0, 0)\n self.setShoes(0, 0, 0)\n Toon.Toon.setDNA(self, dna)\n self.setHat(*oldHat)\n self.setGlasses(*oldGlasses)\n self.setBackpack(*oldBackpack)\n self.setShoes(*oldShoes)\n\n def setHat(self, idx, textureIdx, colorIdx):\n Toon.Toon.setHat(self, idx, textureIdx, colorIdx)\n\n def setGlasses(self, idx, textureIdx, colorIdx):\n Toon.Toon.setGlasses(self, idx, textureIdx, colorIdx)\n\n def setBackpack(self, idx, textureIdx, colorIdx):\n Toon.Toon.setBackpack(self, idx, textureIdx, colorIdx)\n\n def setShoes(self, idx, textureIdx, colorIdx):\n Toon.Toon.setShoes(self, idx, textureIdx, colorIdx)\n\n def setGM(self, type):\n wasGM = self._isGM\n self._isGM = type != 0\n self._gmType = None\n if self._isGM:\n self._gmType = type\n if self._isGM != wasGM:\n self._handleGMName()\n\n def setExperience(self, experience):\n self.experience = Experience.Experience(experience, self)\n if self.inventory:\n self.inventory.updateGUI()\n\n def setInventory(self, inventoryNetString):\n if not self.inventory:\n self.inventory = InventoryNew.InventoryNew(self, inventoryNetString)\n self.inventory.updateInvString(inventoryNetString)\n\n def setLastHood(self, lastHood):\n self.lastHood = lastHood\n\n def setBattleId(self, battleId):\n self.battleId = battleId\n messenger.send('ToonBattleIdUpdate', [self.doId])\n\n def b_setSCToontask(self, taskId, toNpcId, toonProgress, msgIndex):\n self.setSCToontask(taskId, toNpcId, toonProgress, msgIndex)\n self.d_setSCToontask(taskId, toNpcId, toonProgress, msgIndex)\n return None\n\n def d_setSCToontask(self, taskId, toNpcId, toonProgress, msgIndex):\n messenger.send('wakeup')\n self.sendUpdate('setSCToontask', [taskId,\n toNpcId,\n toonProgress,\n msgIndex])\n\n def setSCToontask(self, taskId, toNpcId, toonProgress, msgIndex):\n if self.doId in base.localAvatar.ignoreList:\n return\n chatString = TTSCDecoders.decodeTTSCToontaskMsg(taskId, toNpcId, toonProgress, msgIndex)\n if chatString:\n self.setChatAbsolute(chatString, CFSpeech | CFQuicktalker | CFTimeout)\n\n def b_setSCSinging(self, msgIndex):\n self.setSCSinging(msgIndex)\n self.d_setSCSinging(msgIndex)\n return None\n\n def d_setSCSinging(self, msgIndex):\n messenger.send('wakeup')\n self.sendUpdate('setSCSinging', [msgIndex])\n\n def sendLogSuspiciousEvent(self, msg):\n localAvatar.sendUpdate('logSuspiciousEvent', ['%s for %s' % (msg, self.doId)])\n\n def setSCSinging(self, msgIndex):\n self.sendUpdate('logSuspiciousEvent', ['invalid msgIndex in setSCSinging: %s from %s' % (msgIndex, self.doId)])\n\n def d_reqSCResistance(self, msgIndex):\n messenger.send('wakeup')\n nearbyPlayers = self.getNearbyPlayers(ResistanceChat.EFFECT_RADIUS)\n self.sendUpdate('reqSCResistance', [msgIndex, nearbyPlayers])\n\n def getNearbyPlayers(self, radius, includeSelf = True):\n nearbyToons = []\n toonIds = self.cr.getObjectsOfExactClass(DistributedToon)\n for toonId, toon in toonIds.items():\n if toon is not self:\n dist = toon.getDistance(self)\n if dist < radius:\n nearbyToons.append(toonId)\n\n if includeSelf:\n nearbyToons.append(self.doId)\n return nearbyToons\n\n def setSCResistance(self, msgIndex, nearbyToons = []):\n chatString = TTSCDecoders.decodeTTSCResistanceMsg(msgIndex)\n if chatString:\n self.setChatAbsolute(chatString, CFSpeech | CFTimeout)\n ResistanceChat.doEffect(msgIndex, self, nearbyToons)\n\n def d_battleSOS(self, requesterId, sendToId):\n self.cr.ttiFriendsManager.d_battleSOS(sendToId)\n\n def battleSOS(self, requesterId):\n avatar = base.cr.identifyAvatar(requesterId)\n\n if isinstance(avatar, (DistributedToon, FriendHandle.FriendHandle)):\n self.setSystemMessage(requesterId,\n TTLocalizer.MovieSOSWhisperHelp % avatar.getName(),\n whisperType=WTBattleSOS\n )\n elif avatar:\n self.notify.warning('got battleSOS from non-toon %s' % requesterId)\n\n def getDialogueArray(self, *args):\n if hasattr(self, 'animalSound'):\n dialogueArrays = [\n Toon.DogDialogueArray,\n Toon.CatDialogueArray,\n Toon.HorseDialogueArray,\n Toon.MouseDialogueArray,\n Toon.RabbitDialogueArray,\n Toon.DuckDialogueArray,\n Toon.MonkeyDialogueArray,\n Toon.BearDialogueArray,\n Toon.PigDialogueArray,\n ]\n return dialogueArrays[self.animalSound]\n return Toon.Toon.getDialogueArray(self, *args)\n\n def setDefaultShard(self, shard):\n self.defaultShard = shard\n\n def setDefaultZone(self, zoneId):\n if zoneId >= 20000 and zoneId < 22000:\n zoneId = zoneId + 2000\n try:\n hoodPhase = base.cr.hoodMgr.getPhaseFromHood(zoneId)\n except:\n self.defaultZone = ToontownGlobals.ToontownCentral\n return\n\n if ZoneUtil.getCanonicalHoodId(zoneId) == ToontownGlobals.FunnyFarm:\n self.defaultZone = ToontownGlobals.ToontownCentral\n return\n if not base.cr.isPaid() or launcher and not launcher.getPhaseComplete(hoodPhase):\n self.defaultZone = ToontownGlobals.ToontownCentral\n else:\n self.defaultZone = zoneId\n\n def setShtickerBook(self, string):\n pass\n\n def setAsGM(self, state):\n self.notify.debug('Setting GM State: %s' % state)\n DistributedPlayer.DistributedPlayer.setAsGM(self, state)\n\n def d_updateGMNameTag(self):\n self.refreshName()\n\n def updateGMNameTag(self, tagString, color, state):\n try:\n unicode(tagString, 'utf-8')\n except UnicodeDecodeError:\n self.sendUpdate('logSuspiciousEvent', ['invalid GM name tag: %s from %s' % (tagString, self.doId)])\n return\n\n def refreshName(self):\n return\n self.notify.debug('Refreshing GM Nametag String: %s Color: %s State: %s' % (self.gmNameTagString, self.gmNameTagColor, self.gmNameTagEnabled))\n if hasattr(self, 'nametag') and self.gmNameTagEnabled:\n self.setDisplayName(self.gmNameTagString)\n self.setName(self.gmNameTagString)\n self.trophyStar1 = loader.loadModel('models/misc/smiley')\n self.trophyStar1.reparentTo(self.nametag.getIcon())\n self.trophyStar1.setScale(1)\n self.trophyStar1.setZ(2.25)\n self.trophyStar1.setColor(Vec4(0.75, 0.75, 0.75, 0.75))\n self.trophyStar1.setTransparency(1)\n self.trophyStarSpeed = 15\n else:\n taskMgr.add(self.__refreshNameCallBack, self.uniqueName('refreshNameCallBack'))\n\n def __starSpin1(self, task):\n now = globalClock.getFrameTime()\n r = now * 90 % 360.0\n self.trophyStar1.setH(r)\n return Task.cont\n\n def __refreshNameCallBack(self, task):\n if hasattr(self, 'nametag') and self.nametag.getName() != '':\n self.refreshName()\n return Task.done\n else:\n return Task.cont\n\n def setTalk(self, fromAV, fromAC, avatarName, chat, mods, flags):\n timestamp = time.strftime('%m-%d-%Y %H:%M:%S', time.localtime())\n if fromAV == 0:\n print ':%s: setTalk: %r, %r, %r' % (timestamp, self.doId, self.name, chat)\n else:\n print ':%s: setTalk: %r, %r, %r' % (timestamp, fromAV, avatarName, chat)\n\n if base.cr.avatarFriendsManager.checkIgnored(fromAV):\n self.d_setWhisperIgnored(fromAV)\n return\n if fromAV in self.ignoreList:\n self.d_setWhisperIgnored(fromAV)\n return\n if base.config.GetBool('want-sleep-reply-on-regular-chat', 0):\n if base.localAvatar.sleepFlag == 1:\n base.cr.ttiFriendsManager.d_sleepAutoReply(fromAV)\n newText, scrubbed = self.scrubTalk(chat, mods)\n self.displayTalk(newText)\n base.talkAssistant.receiveOpenTalk(fromAV, avatarName, fromAC, None, newText)\n\n def isAvFriend(self, avId):\n return base.cr.isFriend(avId) or base.cr.playerFriendsManager.isAvatarOwnerPlayerFriend(avId)\n\n def setTalkWhisper(self, fromAV, fromAC, avatarName, chat, mods, flags):\n if not localAvatar.acceptingNonFriendWhispers:\n if not self.isAvFriend(fromAV):\n return\n if base.cr.avatarFriendsManager.checkIgnored(fromAV):\n self.d_setWhisperIgnored(fromAV)\n return\n if fromAV in self.ignoreList:\n self.d_setWhisperIgnored(fromAV)\n return\n if base.config.GetBool('ignore-whispers', 0):\n return\n if base.localAvatar.sleepFlag == 1:\n if not base.cr.identifyAvatar(fromAV) == base.localAvatar:\n base.cr.ttiFriendsManager.d_sleepAutoReply(fromAV)\n newText, scrubbed = self.scrubTalk(chat, mods)\n self.displayTalkWhisper(fromAV, avatarName, chat, mods)\n timestamp = time.strftime('%m-%d-%Y %H:%M:%S', time.localtime())\n print ':%s: receiveWhisperTalk: %r, %r, %r, %r, %r, %r, %r' % (timestamp, fromAV, avatarName, fromAC, None, self.doId, self.getName(), newText)\n base.talkAssistant.receiveWhisperTalk(fromAV, avatarName, fromAC, None, self.doId, self.getName(), newText)\n\n def setSleepAutoReply(self, fromId):\n pass\n\n def _isValidWhisperSource(self, source):\n return isinstance(source, (DistributedToon, FriendHandle.FriendHandle))\n\n def setWhisperSCEmoteFrom(self, fromId, emoteId):\n handle = base.cr.identifyFriend(fromId)\n if handle == None:\n return\n if not self._isValidWhisperSource(handle):\n self.notify.warning('setWhisperSCEmoteFrom non-toon %s' % fromId)\n return\n if not localAvatar.acceptingNonFriendWhispers:\n if not self.isAvFriend(fromId):\n return\n if base.cr.avatarFriendsManager.checkIgnored(fromId):\n self.d_setWhisperIgnored(fromId)\n return\n if base.localAvatar.sleepFlag == 1:\n if not base.cr.identifyAvatar(fromId) == base.localAvatar:\n base.cr.ttiFriendsManager.d_sleepAutoReply(fromId)\n chatString = SCDecoders.decodeSCEmoteWhisperMsg(emoteId, handle.getName())\n if chatString:\n self.displayWhisper(fromId, chatString, WTEmote)\n base.talkAssistant.receiveAvatarWhisperSpeedChat(TalkAssistant.SPEEDCHAT_EMOTE, emoteId, fromId)\n return\n\n def setWhisperSCFrom(self, fromId, msgIndex):\n handle = base.cr.identifyFriend(fromId)\n if handle == None:\n return\n if not self._isValidWhisperSource(handle):\n self.notify.warning('setWhisperSCFrom non-toon %s' % fromId)\n return\n if not localAvatar.acceptingNonFriendWhispers:\n if not self.isAvFriend(fromId):\n return\n if base.cr.avatarFriendsManager.checkIgnored(fromId):\n self.d_setWhisperIgnored(fromId)\n return\n if fromId in self.ignoreList:\n self.d_setWhisperIgnored(fromId)\n return\n if base.localAvatar.sleepFlag == 1:\n if not base.cr.identifyAvatar(fromId) == base.localAvatar:\n base.cr.ttiFriendsManager.d_sleepAutoReply(fromId)\n chatString = SCDecoders.decodeSCStaticTextMsg(msgIndex)\n if chatString:\n self.displayWhisper(fromId, chatString, WTQuickTalker)\n base.talkAssistant.receiveAvatarWhisperSpeedChat(TalkAssistant.SPEEDCHAT_NORMAL, msgIndex, fromId)\n return\n\n def setWhisperSCCustomFrom(self, fromId, msgIndex):\n handle = base.cr.identifyFriend(fromId)\n if handle == None:\n return\n if not localAvatar.acceptingNonFriendWhispers:\n if not self.isAvFriend(fromId):\n return\n return DistributedPlayer.DistributedPlayer.setWhisperSCCustomFrom(self, fromId, msgIndex)\n\n def whisperSCToontaskTo(self, taskId, toNpcId, toonProgress, msgIndex, sendToId):\n messenger.send('wakeup')\n\n base.cr.ttiFriendsManager.d_whisperSCToontaskTo(sendToId, taskId,\n toNpcId, toonProgress, msgIndex\n )\n\n def setWhisperSCToontaskFrom(self, fromId, taskId, toNpcId, toonProgress, msgIndex):\n sender = base.cr.identifyFriend(fromId)\n if sender is None:\n return\n\n if not localAvatar.acceptingNonFriendWhispers:\n if not self.isAvFriend(fromId):\n return\n\n if fromId in self.ignoreList:\n self.d_setWhisperIgnored(fromId)\n\n chatString = TTSCDecoders.decodeTTSCToontaskMsg(taskId, toNpcId, toonProgress, msgIndex)\n if chatString:\n self.displayWhisper(fromId, chatString, WTQuickTalker)\n\n def setMaxNPCFriends(self, max):\n max &= 32767\n if max != self.maxNPCFriends:\n self.maxNPCFriends = max\n messenger.send(self.uniqueName('maxNPCFriendsChange'))\n else:\n self.maxNPCFriends = max\n\n def getMaxNPCFriends(self):\n return self.maxNPCFriends\n\n def getNPCFriendsDict(self):\n return self.NPCFriendsDict\n\n def setNPCFriendsDict(self, NPCFriendsList):\n NPCFriendsDict = {}\n for friendPair in NPCFriendsList:\n NPCFriendsDict[friendPair[0]] = friendPair[1]\n\n self.NPCFriendsDict = NPCFriendsDict\n\n def setMaxAccessories(self, max):\n self.maxAccessories = max\n\n def getMaxAccessories(self):\n return self.maxAccessories\n\n def setHatList(self, clothesList):\n self.hatList = clothesList\n\n def getHatList(self):\n return self.hatList\n\n def setGlassesList(self, clothesList):\n self.glassesList = clothesList\n\n def getGlassesList(self):\n return self.glassesList\n\n def setBackpackList(self, clothesList):\n self.backpackList = clothesList\n\n def getBackpackList(self):\n return self.backpackList\n\n def setShoesList(self, clothesList):\n self.shoesList = clothesList\n\n def getShoesList(self):\n return self.shoesList\n\n def isTrunkFull(self, extraAccessories = 0):\n numAccessories = (len(self.hatList) + len(self.glassesList) + len(self.backpackList) + len(self.shoesList)) / 3\n return numAccessories + extraAccessories >= self.maxAccessories\n\n def setMaxClothes(self, max):\n self.maxClothes = max\n\n def getMaxClothes(self):\n return self.maxClothes\n\n def getClothesTopsList(self):\n return self.clothesTopsList\n\n def setClothesTopsList(self, clothesList):\n self.clothesTopsList = clothesList\n\n def getClothesBottomsList(self):\n return self.clothesBottomsList\n\n def setClothesBottomsList(self, clothesList):\n self.clothesBottomsList = clothesList\n\n def catalogGenClothes(self, avId):\n if avId == self.doId:\n self.generateToonClothes()\n self.loop('neutral')\n\n def catalogGenAccessories(self, avId):\n if avId == self.doId:\n self.generateToonAccessories()\n self.loop('neutral')\n\n def isClosetFull(self, extraClothes = 0):\n numClothes = len(self.clothesTopsList) / 4 + len(self.clothesBottomsList) / 2\n return numClothes + extraClothes >= self.maxClothes\n\n def setMaxHp(self, hitPoints):\n DistributedPlayer.DistributedPlayer.setMaxHp(self, hitPoints)\n if self.inventory:\n self.inventory.updateGUI()\n\n def died(self):\n messenger.send(self.uniqueName('died'))\n if self.isLocal():\n target_sz = ZoneUtil.getSafeZoneId(self.defaultZone)\n place = self.cr.playGame.getPlace()\n if place and place.fsm:\n place.fsm.request('died', [{'loader': ZoneUtil.getLoaderName(target_sz),\n 'where': ZoneUtil.getWhereName(target_sz, 1),\n 'how': 'teleportIn',\n 'hoodId': target_sz,\n 'zoneId': target_sz,\n 'shardId': None,\n 'avId': -1,\n 'battle': 1}])\n return\n\n def setInterface(self, string):\n pass\n\n def setZonesVisited(self, hoods):\n self.safeZonesVisited = hoods\n\n def setHoodsVisited(self, hoods):\n self.hoodsVisited = hoods\n if ToontownGlobals.SellbotHQ in hoods or ToontownGlobals.CashbotHQ in hoods or ToontownGlobals.LawbotHQ in hoods:\n self.setDisguisePageFlag(1)\n\n def wrtReparentTo(self, parent):\n DistributedSmoothNode.DistributedSmoothNode.wrtReparentTo(self, parent)\n\n def setTutorialAck(self, tutorialAck):\n self.tutorialAck = tutorialAck\n\n def setEarnedExperience(self, earnedExp):\n self.earnedExperience = earnedExp\n\n def b_setTunnelIn(self, endX, tunnelOrigin):\n timestamp = globalClockDelta.getFrameNetworkTime()\n pos = tunnelOrigin.getPos(render)\n h = tunnelOrigin.getH(render)\n self.setTunnelIn(timestamp, endX, pos[0], pos[1], pos[2], h)\n self.d_setTunnelIn(timestamp, endX, pos[0], pos[1], pos[2], h)\n\n def d_setTunnelIn(self, timestamp, endX, x, y, z, h):\n self.sendUpdate('setTunnelIn', [timestamp,\n endX,\n x,\n y,\n z,\n h])\n\n def setTunnelIn(self, timestamp, endX, x, y, z, h):\n t = globalClockDelta.networkToLocalTime(timestamp)\n self.handleTunnelIn(t, endX, x, y, z, h)\n\n def getTunnelInToonTrack(self, endX, tunnelOrigin):\n pivotNode = tunnelOrigin.attachNewNode(self.uniqueName('pivotNode'))\n pivotNode.setPos(*self.tunnelPivotPos)\n pivotNode.setHpr(0, 0, 0)\n pivotY = pivotNode.getY(tunnelOrigin)\n endY = 5.0\n straightLerpDur = abs(endY - pivotY) / ToontownGlobals.ToonForwardSpeed\n pivotDur = 2.0\n pivotLerpDur = pivotDur * (90.0 / self.pivotAngle)\n self.reparentTo(pivotNode)\n self.setPos(0, 0, 0)\n self.setX(tunnelOrigin, endX)\n targetX = self.getX()\n self.setX(self.tunnelCenterOffset + (targetX - self.tunnelCenterOffset) * (1.0 - self.tunnelCenterInfluence))\n self.setHpr(tunnelOrigin, 0, 0, 0)\n pivotNode.setH(-self.pivotAngle)\n return Sequence(Wait(0.8), Parallel(LerpHprInterval(pivotNode, pivotDur, hpr=Point3(0, 0, 0), name=self.uniqueName('tunnelInPivot')), Sequence(Wait(pivotDur - pivotLerpDur), LerpPosInterval(self, pivotLerpDur, pos=Point3(targetX, 0, 0), name=self.uniqueName('tunnelInPivotLerpPos')))), Func(self.wrtReparentTo, render), Func(pivotNode.removeNode), LerpPosInterval(self, straightLerpDur, pos=Point3(endX, endY, 0.1), other=tunnelOrigin, name=self.uniqueName('tunnelInStraightLerp')))\n\n def handleTunnelIn(self, startTime, endX, x, y, z, h):\n self.stopSmooth()\n tunnelOrigin = render.attachNewNode('tunnelOrigin')\n tunnelOrigin.setPosHpr(x, y, z, h, 0, 0)\n if self.tunnelTrack:\n self.tunnelTrack.finish()\n self.tunnelTrack = Sequence(self.getTunnelInToonTrack(endX, tunnelOrigin), Func(tunnelOrigin.removeNode), Func(self.startSmooth))\n tOffset = globalClock.getFrameTime() - (startTime + self.smoother.getDelay())\n if tOffset < 0.0:\n self.tunnelTrack = Sequence(Wait(-tOffset), self.tunnelTrack)\n self.tunnelTrack.start()\n else:\n self.tunnelTrack.start(tOffset)\n\n def b_setTunnelOut(self, startX, startY, tunnelOrigin):\n timestamp = globalClockDelta.getFrameNetworkTime()\n pos = tunnelOrigin.getPos(render)\n h = tunnelOrigin.getH(render)\n self.setTunnelOut(timestamp, startX, startY, pos[0], pos[1], pos[2], h)\n self.d_setTunnelOut(timestamp, startX, startY, pos[0], pos[1], pos[2], h)\n\n def d_setTunnelOut(self, timestamp, startX, startY, x, y, z, h):\n self.sendUpdate('setTunnelOut', [timestamp,\n startX,\n startY,\n x,\n y,\n z,\n h])\n\n def setTunnelOut(self, timestamp, startX, startY, x, y, z, h):\n t = globalClockDelta.networkToLocalTime(timestamp)\n self.handleTunnelOut(t, startX, startY, x, y, z, h)\n\n def getTunnelOutToonTrack(self, startX, startY, tunnelOrigin):\n startPos = self.getPos(tunnelOrigin)\n startHpr = self.getHpr(tunnelOrigin)\n reducedAvH = PythonUtil.fitDestAngle2Src(startHpr[0], 180)\n pivotNode = tunnelOrigin.attachNewNode(self.uniqueName('pivotNode'))\n pivotNode.setPos(*self.tunnelPivotPos)\n pivotNode.setHpr(0, 0, 0)\n pivotY = pivotNode.getY(tunnelOrigin)\n straightLerpDur = abs(startY - pivotY) / ToontownGlobals.ToonForwardSpeed\n pivotDur = 2.0\n pivotLerpDur = pivotDur * (90.0 / self.pivotAngle)\n\n def getTargetPos(self = self):\n pos = self.getPos()\n return Point3(self.tunnelCenterOffset + (pos[0] - self.tunnelCenterOffset) * (1.0 - self.tunnelCenterInfluence), pos[1], pos[2])\n\n return Sequence(Parallel(LerpPosInterval(self, straightLerpDur, pos=Point3(startX, pivotY, 0.1), startPos=startPos, other=tunnelOrigin, name=self.uniqueName('tunnelOutStraightLerp')), LerpHprInterval(self, straightLerpDur * 0.8, hpr=Point3(reducedAvH, 0, 0), startHpr=startHpr, other=tunnelOrigin, name=self.uniqueName('tunnelOutStraightLerpHpr'))), Func(self.wrtReparentTo, pivotNode), Parallel(LerpHprInterval(pivotNode, pivotDur, hpr=Point3(-self.pivotAngle, 0, 0), name=self.uniqueName('tunnelOutPivot')), LerpPosInterval(self, pivotLerpDur, pos=getTargetPos, name=self.uniqueName('tunnelOutPivotLerpPos'))), Func(self.wrtReparentTo, render), Func(pivotNode.removeNode))\n\n def handleTunnelOut(self, startTime, startX, startY, x, y, z, h):\n tunnelOrigin = render.attachNewNode('tunnelOrigin')\n tunnelOrigin.setPosHpr(x, y, z, h, 0, 0)\n if self.tunnelTrack:\n self.tunnelTrack.finish()\n self.tunnelTrack = Sequence(Func(self.stopSmooth), self.getTunnelOutToonTrack(startX, startY, tunnelOrigin), Func(self.detachNode), Func(tunnelOrigin.removeNode))\n tOffset = globalClock.getFrameTime() - (startTime + self.smoother.getDelay())\n if tOffset < 0.0:\n self.tunnelTrack = Sequence(Wait(-tOffset), self.tunnelTrack)\n self.tunnelTrack.start()\n else:\n self.tunnelTrack.start(tOffset)\n\n def enterTeleportOut(self, *args, **kw):\n Toon.Toon.enterTeleportOut(self, *args, **kw)\n if self.track:\n self.track.delayDelete = DelayDelete.DelayDelete(self, 'enterTeleportOut')\n\n def exitTeleportOut(self):\n if self.track != None:\n DelayDelete.cleanupDelayDeletes(self.track)\n Toon.Toon.exitTeleportOut(self)\n return\n\n def b_setAnimState(self, animName, animMultiplier = 1.0, callback = None, extraArgs = []):\n self.d_setAnimState(animName, animMultiplier, None, extraArgs)\n self.setAnimState(animName, animMultiplier, None, None, callback, extraArgs)\n return\n\n def d_setAnimState(self, animName, animMultiplier = 1.0, timestamp = None, extraArgs = []):\n timestamp = globalClockDelta.getFrameNetworkTime()\n self.sendUpdate('setAnimState', [animName, animMultiplier, timestamp])\n\n def setAnimState(self, animName, animMultiplier = 1.0, timestamp = None, animType = None, callback = None, extraArgs = []):\n if not animName or animName == 'None':\n return\n if timestamp == None:\n ts = 0.0\n else:\n ts = globalClockDelta.localElapsedTime(timestamp)\n if base.config.GetBool('check-invalid-anims', True):\n if animMultiplier > 1.0 and animName in ['neutral']:\n animMultiplier = 1.0\n if self.animFSM.getStateNamed(animName):\n self.animFSM.request(animName, [animMultiplier,\n ts,\n callback,\n extraArgs])\n self.cleanupPieInHand()\n return\n\n def b_setEmoteState(self, animIndex, animMultiplier):\n self.setEmoteState(animIndex, animMultiplier)\n self.d_setEmoteState(animIndex, animMultiplier)\n\n def d_setEmoteState(self, animIndex, animMultiplier):\n timestamp = globalClockDelta.getFrameNetworkTime()\n self.sendUpdate('setEmoteState', [animIndex, animMultiplier, timestamp])\n\n def setEmoteState(self, animIndex, animMultiplier, timestamp = None):\n if animIndex == TTEmote.EmoteClear:\n return\n if timestamp == None:\n ts = 0.0\n else:\n ts = globalClockDelta.localElapsedTime(timestamp)\n callback = None\n extraArgs = []\n extraArgs.insert(0, animIndex)\n self.doEmote(animIndex, animMultiplier, ts, callback, extraArgs)\n return\n\n def setCogStatus(self, cogStatusList):\n self.cogs = cogStatusList\n\n def setCogCount(self, cogCountList):\n self.cogCounts = cogCountList\n if hasattr(self, 'suitPage'):\n self.suitPage.updatePage()\n\n def setCogRadar(self, radar):\n self.cogRadar = radar\n if hasattr(self, 'suitPage'):\n self.suitPage.updateCogRadarButtons(radar)\n\n def setBuildingRadar(self, radar):\n self.buildingRadar = radar\n if hasattr(self, 'suitPage'):\n self.suitPage.updateBuildingRadarButtons(radar)\n\n def setCogTypes(self, types):\n self.cogTypes = types\n if self.disguisePage:\n self.disguisePage.updatePage()\n\n def getCogTypes(self):\n return self.cogTypes\n\n def setCogLevels(self, levels):\n self.cogLevels = levels\n if self.disguisePage:\n self.disguisePage.updatePage()\n\n def getCogLevels(self):\n return self.cogLevels\n\n def setCogParts(self, parts):\n self.cogParts = parts\n if self.disguisePage:\n self.disguisePage.updatePage()\n\n def getCogParts(self):\n return self.cogParts\n\n def setCogMerits(self, merits):\n self.cogMerits = merits\n if self.disguisePage:\n self.disguisePage.updatePage()\n\n def readyForPromotion(self, dept):\n merits = base.localAvatar.cogMerits[dept]\n totalMerits = CogDisguiseGlobals.getTotalMerits(self, dept)\n if merits >= totalMerits:\n return 1\n else:\n return 0\n\n def setCogIndex(self, index):\n self.cogIndex = index\n if self.cogIndex == -1:\n if self.isDisguised:\n self.takeOffSuit()\n else:\n parts = self.getCogParts()\n if CogDisguiseGlobals.isPaidSuitComplete(self, parts, index):\n cogIndex = self.cogTypes[index] + SuitDNA.suitsPerDept * index\n cog = SuitDNA.suitHeadTypes[cogIndex]\n self.putOnSuit(cog)\n else:\n self.putOnSuit(index, rental=True)\n\n def setPromotionStatus(self, status):\n self.promotionStatus = status\n\n def isCog(self):\n if self.cogIndex == -1:\n return 0\n else:\n return 1\n\n def setDisguisePageFlag(self, flag):\n if flag and hasattr(self, 'book'):\n self.loadDisguisePages()\n self.disguisePageFlag = flag\n\n def setSosPageFlag(self, flag):\n if flag and hasattr(self, 'book'):\n self.loadSosPages()\n self.sosPageFlag = flag\n\n def setFishCollection(self, genusList, speciesList, weightList):\n self.fishCollection = FishCollection.FishCollection()\n self.fishCollection.makeFromNetLists(genusList, speciesList, weightList)\n\n def getFishCollection(self):\n return self.fishCollection\n\n def setMaxFishTank(self, maxTank):\n self.maxFishTank = maxTank\n\n def getMaxFishTank(self):\n return self.maxFishTank\n\n def setFishTank(self, genusList, speciesList, weightList):\n self.fishTank = FishTank.FishTank()\n self.fishTank.makeFromNetLists(genusList, speciesList, weightList)\n messenger.send(self.uniqueName('fishTankChange'))\n\n def getFishTank(self):\n return self.fishTank\n\n def isFishTankFull(self):\n return len(self.fishTank) >= self.maxFishTank\n\n def setFishingRod(self, rodId):\n self.fishingRod = rodId\n\n def getFishingRod(self):\n return self.fishingRod\n\n def setFishingTrophies(self, trophyList):\n self.fishingTrophies = trophyList\n\n def getFishingTrophies(self):\n return self.fishingTrophies\n\n def setQuests(self, flattenedQuests):\n questList = []\n questLen = 5\n for i in xrange(0, len(flattenedQuests), questLen):\n questList.append(flattenedQuests[i:i + questLen])\n\n self.quests = questList\n if self == base.localAvatar:\n messenger.send('questsChanged')\n\n def setQuestCarryLimit(self, limit):\n self.questCarryLimit = limit\n if self == base.localAvatar:\n messenger.send('questsChanged')\n\n def getQuestCarryLimit(self):\n return self.questCarryLimit\n\n def d_requestDeleteQuest(self, questDesc):\n self.sendUpdate('requestDeleteQuest', [list(questDesc)])\n\n def setMaxCarry(self, maxCarry):\n self.maxCarry = maxCarry\n if self.inventory:\n self.inventory.updateGUI()\n\n def getMaxCarry(self):\n return self.maxCarry\n\n def setCheesyEffect(self, effect, hoodId, expireTime):\n self.savedCheesyEffect = effect\n self.savedCheesyHoodId = hoodId\n self.savedCheesyExpireTime = expireTime\n if self == base.localAvatar:\n self.notify.debug('setCheesyEffect(%s, %s, %s)' % (effect, hoodId, expireTime))\n if effect != ToontownGlobals.CENormal:\n serverTime = time.time() + self.cr.getServerDelta()\n duration = expireTime * 60 - serverTime\n if duration < 0:\n self.notify.debug('effect should have expired %s ago.' % PythonUtil.formatElapsedSeconds(-duration))\n else:\n self.notify.debug('effect will expire in %s.' % PythonUtil.formatElapsedSeconds(duration))\n if self.activeState == DistributedObject.ESGenerated:\n self.reconsiderCheesyEffect(lerpTime=0.5)\n else:\n self.reconsiderCheesyEffect()\n\n def reconsiderCheesyEffect(self, lerpTime = 0):\n effect = self.savedCheesyEffect\n hoodId = self.savedCheesyHoodId\n if not self.cr.areCheesyEffectsAllowed():\n effect = ToontownGlobals.CENormal\n if hoodId != 0:\n try:\n currentHoodId = base.cr.playGame.hood.id\n except:\n currentHoodId = None\n\n if hoodId == 1:\n if currentHoodId == ToontownGlobals.ToontownCentral:\n effect = ToontownGlobals.CENormal\n elif currentHoodId != None and currentHoodId != hoodId:\n effect = ToontownGlobals.CENormal\n if self.ghostMode:\n effect = ToontownGlobals.CEGhost\n self.applyCheesyEffect(effect, lerpTime=lerpTime)\n return\n\n def setGhostMode(self, flag):\n if self.ghostMode != flag:\n self.ghostMode = flag\n if not hasattr(self, 'cr'):\n return\n if self.activeState <= DistributedObject.ESDisabled:\n self.notify.debug('not applying cheesy effect to disabled Toon')\n elif self.activeState == DistributedObject.ESGenerating:\n self.reconsiderCheesyEffect()\n elif self.activeState == DistributedObject.ESGenerated:\n self.reconsiderCheesyEffect(lerpTime=0.5)\n else:\n self.notify.warning('unknown activeState: %s' % self.activeState)\n self.showNametag2d()\n self.showNametag3d()\n if hasattr(self, 'collNode'):\n if self.ghostMode:\n self.collNode.setCollideMask(ToontownGlobals.GhostBitmask)\n else:\n self.collNode.setCollideMask(ToontownGlobals.WallBitmask | ToontownGlobals.PieBitmask)\n if self.isLocal():\n if self.ghostMode:\n self.useGhostControls()\n else:\n self.useWalkControls()\n\n if hasattr(base, 'wantPets') and base.wantPets:\n\n def setPetTrickPhrases(self, petTricks):\n self.petTrickPhrases = petTricks\n if self.isLocal():\n messenger.send('petTrickPhrasesChanged')\n\n def setCustomMessages(self, customMessages):\n self.customMessages = customMessages\n if self.isLocal():\n messenger.send('customMessagesChanged')\n\n def setResistanceMessages(self, resistanceMessages):\n self.resistanceMessages = resistanceMessages\n if self.isLocal():\n messenger.send('resistanceMessagesChanged')\n\n def getResistanceMessageCharges(self, textId):\n msgs = self.resistanceMessages\n for i in xrange(len(msgs)):\n if msgs[i][0] == textId:\n return msgs[i][1]\n\n return 0\n\n def setCatalogSchedule(self, currentWeek, nextTime):\n self.catalogScheduleCurrentWeek = currentWeek\n self.catalogScheduleNextTime = nextTime\n if self.isLocal():\n self.notify.debug('setCatalogSchedule(%s, %s)' % (currentWeek, nextTime))\n if nextTime:\n serverTime = time.time() + self.cr.getServerDelta()\n duration = nextTime * 60 - serverTime\n self.notify.debug('next catalog in %s.' % PythonUtil.formatElapsedSeconds(duration))\n\n def setCatalog(self, monthlyCatalog, weeklyCatalog, backCatalog):\n self.monthlyCatalog = CatalogItemList.CatalogItemList(monthlyCatalog)\n self.weeklyCatalog = CatalogItemList.CatalogItemList(weeklyCatalog)\n self.backCatalog = CatalogItemList.CatalogItemList(backCatalog)\n if self.catalogNotify == ToontownGlobals.NewItems:\n self.catalogNotify = ToontownGlobals.OldItems\n\n def setCatalogNotify(self, catalogNotify, mailboxNotify):\n if len(self.weeklyCatalog) + len(self.monthlyCatalog) == 0:\n catalogNotify = ToontownGlobals.NoItems\n if len(self.mailboxContents) == 0:\n mailboxNotify = ToontownGlobals.NoItems\n self.catalogNotify = catalogNotify\n self.mailboxNotify = mailboxNotify\n if self.isLocal():\n self.gotCatalogNotify = 1\n self.refreshOnscreenButtons()\n\n def setDeliverySchedule(self, onOrder):\n self.onOrder = CatalogItemList.CatalogItemList(onOrder, store=CatalogItem.Customization | CatalogItem.DeliveryDate)\n if self == base.localAvatar:\n nextTime = self.onOrder.getNextDeliveryDate()\n if nextTime != None:\n serverTime = time.time() + self.cr.getServerDelta()\n duration = nextTime * 60 - serverTime\n self.notify.debug('next delivery in %s.' % PythonUtil.formatElapsedSeconds(duration))\n messenger.send('setDeliverySchedule-%s' % self.doId)\n return\n\n def setMailboxContents(self, mailboxContents):\n self.mailboxContents = CatalogItemList.CatalogItemList(mailboxContents, store=CatalogItem.Customization)\n messenger.send('setMailboxContents-%s' % self.doId)\n\n def setAwardSchedule(self, onOrder):\n self.onAwardOrder = CatalogItemList.CatalogItemList(onOrder, store=CatalogItem.Customization | CatalogItem.DeliveryDate)\n if self == base.localAvatar:\n nextTime = self.onAwardOrder.getNextDeliveryDate()\n if nextTime != None:\n serverTime = time.time() + self.cr.getServerDelta()\n duration = nextTime * 60 - serverTime\n self.notify.debug('next delivery in %s.' % PythonUtil.formatElapsedSeconds(duration))\n messenger.send('setAwardSchedule-%s' % self.doId)\n return\n\n def setAwardMailboxContents(self, awardMailboxContents):\n self.notify.debug('Setting awardMailboxContents to %s.' % awardMailboxContents)\n self.awardMailboxContents = CatalogItemList.CatalogItemList(awardMailboxContents, store=CatalogItem.Customization)\n self.notify.debug('awardMailboxContents is %s.' % self.awardMailboxContents)\n messenger.send('setAwardMailboxContents-%s' % self.doId)\n\n def setAwardNotify(self, awardNotify):\n self.notify.debug('setAwardNotify( %s )' % awardNotify)\n self.awardNotify = awardNotify\n if self.isLocal():\n self.gotCatalogNotify = 1\n self.refreshOnscreenButtons()\n\n def setGiftSchedule(self, onGiftOrder):\n self.onGiftOrder = CatalogItemList.CatalogItemList(onGiftOrder, store=CatalogItem.Customization | CatalogItem.DeliveryDate)\n if self == base.localAvatar:\n nextTime = self.onGiftOrder.getNextDeliveryDate()\n if nextTime != None:\n serverTime = time.time() + self.cr.getServerDelta()\n duration = nextTime * 60 - serverTime\n self.notify.debug('next delivery in %s.' % PythonUtil.formatElapsedSeconds(duration))\n return\n\n def playSplashEffect(self, x, y, z):\n if localAvatar.zoneId not in [ToontownGlobals.DonaldsDock, ToontownGlobals.OutdoorZone] and (not hasattr(localAvatar, 'inEstate') or localAvatar.inEstate != 1):\n if random.random() < 0.1:\n self.sendLogSuspiciousEvent('AvatarHackWarning! playing hacked splash effect')\n return\n from toontown.effects import Splash\n if self.splash == None:\n self.splash = Splash.Splash(render)\n self.splash.setPos(x, y, z)\n self.splash.setScale(2)\n self.splash.play()\n place = base.cr.playGame.getPlace()\n if place:\n if hasattr(place.loader, 'submergeSound'):\n base.playSfx(place.loader.submergeSound, node=self)\n return\n\n def d_playSplashEffect(self, x, y, z):\n self.sendUpdate('playSplashEffect', [x, y, z])\n\n def setTrackAccess(self, trackArray):\n self.trackArray = trackArray\n if self.inventory:\n self.inventory.updateGUI()\n\n def getTrackAccess(self):\n return self.trackArray\n\n def hasTrackAccess(self, track):\n return self.trackArray[track]\n\n def setTrackProgress(self, trackId, progress):\n self.trackProgressId = trackId\n self.trackProgress = progress\n if hasattr(self, 'trackPage'):\n self.trackPage.updatePage()\n\n def getTrackProgress(self):\n return [self.trackProgressId, self.trackProgress]\n\n def getTrackProgressAsArray(self, maxLength = 15):\n shifts = map(operator.rshift, maxLength * [self.trackProgress], range(maxLength - 1, -1, -1))\n digits = map(operator.mod, shifts, maxLength * [2])\n digits.reverse()\n return digits\n\n def setTeleportAccess(self, teleportZoneArray):\n self.teleportZoneArray = teleportZoneArray\n\n def getTeleportAccess(self):\n return self.teleportZoneArray\n\n def hasTeleportAccess(self, zoneId):\n return zoneId in self.teleportZoneArray\n\n def setScavengerHunt(self, scavengerHuntArray):\n self.scavengerHuntArray = scavengerHuntArray\n\n def getScavengerHunt(self):\n return self.scavengerHuntArray\n\n def setQuestHistory(self, questList):\n self.questHistory = questList\n\n def getQuestHistory(self):\n return self.questHistory\n\n def setRewardHistory(self, rewardTier, rewardList):\n self.rewardTier = rewardTier\n self.rewardHistory = rewardList\n\n def getRewardHistory(self):\n return (self.rewardTier, self.rewardHistory)\n\n def doSmoothTask(self, task):\n self.smoother.computeAndApplySmoothPosHpr(self, self)\n self.setSpeed(self.smoother.getSmoothForwardVelocity(), self.smoother.getSmoothRotationalVelocity())\n return Task.cont\n\n def d_setParent(self, parentToken):\n DistributedSmoothNode.DistributedSmoothNode.d_setParent(self, parentToken)\n\n def setEmoteAccess(self, bits):\n self.emoteAccess = bits\n if self == base.localAvatar:\n messenger.send('emotesChanged')\n\n def b_setHouseId(self, id):\n self.setHouseId(id)\n self.d_setHouseId(id)\n\n def d_setHouseId(self, id):\n self.sendUpdate('setHouseId', [id])\n\n def setHouseId(self, id):\n self.houseId = id\n\n def getHouseId(self):\n return self.houseId\n\n def setPosIndex(self, index):\n self.posIndex = index\n\n def getPosIndex(self):\n return self.posIndex\n\n def b_setSpeedChatStyleIndex(self, index):\n realIndexToSend = 0\n if type(index) == type(0) and 0 <= index and index < len(speedChatStyles):\n realIndexToSend = index\n self.setSpeedChatStyleIndex(realIndexToSend)\n self.d_setSpeedChatStyleIndex(realIndexToSend)\n\n def d_setSpeedChatStyleIndex(self, index):\n realIndexToSend = 0\n if type(index) == type(0) and 0 <= index and index < len(speedChatStyles):\n realIndexToSend = index\n self.sendUpdate('setSpeedChatStyleIndex', [realIndexToSend])\n\n def setSpeedChatStyleIndex(self, index):\n realIndexToUse = 0\n if type(index) == type(0) and 0 <= index and index < len(speedChatStyles):\n realIndexToUse = index\n self.speedChatStyleIndex = realIndexToUse\n nameKey, arrowColor, rolloverColor, frameColor = speedChatStyles[realIndexToUse]\n self.nametag.setSpeedChatColor(VBase4(frameColor[0], frameColor[1], frameColor[2], 1))\n self.nametag.updateAll()\n if self.isLocal():\n messenger.send('SpeedChatStyleChange', [])\n\n def getSpeedChatStyleIndex(self):\n return self.speedChatStyleIndex\n\n def getMaxMoney(self):\n return 10000\n\n def setMoney(self, money):\n if money != self.money:\n self.money = money\n messenger.send(self.uniqueName('moneyChange'), [self.money])\n\n def getMoney(self):\n return self.money\n\n def setMaxBankMoney(self, maxMoney):\n self.maxBankMoney = maxMoney\n\n def getMaxBankMoney(self):\n return self.maxBankMoney\n\n def setBankMoney(self, money):\n self.bankMoney = money\n messenger.send(self.uniqueName('bankMoneyChange'), [self.bankMoney])\n\n def getBankMoney(self):\n return self.bankMoney\n\n def getTotalMoney(self):\n return self.getBankMoney() + self.getMoney()\n\n def setEmblems(self, emblems):\n if self.emblems != emblems:\n self.emblems = emblems\n messenger.send(self.uniqueName('emblemsChange'), [self.emblems])\n\n def getEmblems(self):\n return self.emblems\n\n def isEnoughEmblemsToBuy(self, itemEmblemPrices):\n for emblemIndex, emblemPrice in enumerate(itemEmblemPrices):\n if emblemIndex >= len(self.emblems):\n return False\n if self.emblems[emblemIndex] < emblemPrice:\n return False\n\n return True\n\n def isEnoughMoneyAndEmblemsToBuy(self, moneyPrice, itemEmblemPrices):\n if self.getTotalMoney() < moneyPrice:\n return False\n for emblemIndex, emblemPrice in enumerate(itemEmblemPrices):\n if emblemIndex >= len(self.emblems):\n return False\n if self.emblems[emblemIndex] < emblemPrice:\n return False\n\n return True\n\n def presentPie(self, x, y, z, h, timestamp32):\n if self.numPies <= 0:\n return\n if not launcher.getPhaseComplete(5):\n return\n lastTossTrack = Sequence()\n if self.tossTrack:\n lastTossTrack = self.tossTrack\n tossTrack = None\n ts = globalClockDelta.localElapsedTime(timestamp32, bits=32)\n ts -= self.smoother.getDelay()\n ival = self.getPresentPieInterval(x, y, z, h)\n if ts > 0:\n startTime = ts\n lastTossTrack.finish()\n else:\n ival = Sequence(Wait(-ts), ival)\n lastTossTrack.finish()\n startTime = 0\n ival = Sequence(ival)\n ival.start(startTime)\n self.tossTrack = ival\n return\n\n def tossPie(self, x, y, z, h, sequence, power, throwType, timestamp32):\n if self.numPies <= 0:\n return\n if self.numPies != ToontownGlobals.FullPies:\n self.setNumPies(self.numPies - 1)\n self.lastTossedPie = globalClock.getFrameTime()\n if not launcher.getPhaseComplete(5):\n return\n lastTossTrack = Sequence()\n if self.tossTrack:\n lastTossTrack = self.tossTrack\n tossTrack = None\n lastPieTrack = Sequence()\n if sequence in self.pieTracks:\n lastPieTrack = self.pieTracks[sequence]\n del self.pieTracks[sequence]\n ts = globalClockDelta.localElapsedTime(timestamp32, bits=32)\n ts -= self.smoother.getDelay()\n toss, pie, flyPie = self.getTossPieInterval(x, y, z, h, power, throwType)\n if ts > 0:\n startTime = ts\n lastTossTrack.finish()\n lastPieTrack.finish()\n else:\n toss = Sequence(Wait(-ts), toss)\n pie = Sequence(Wait(-ts), pie)\n lastTossTrack.finish()\n lastPieTrack.finish()\n startTime = 0\n self.tossTrack = toss\n toss.start(startTime)\n pie = Sequence(pie, Func(self.pieFinishedFlying, sequence))\n self.pieTracks[sequence] = pie\n pie.start(startTime)\n return\n\n def pieFinishedFlying(self, sequence):\n if sequence in self.pieTracks:\n del self.pieTracks[sequence]\n\n def pieFinishedSplatting(self, sequence):\n if sequence in self.splatTracks:\n del self.splatTracks[sequence]\n\n def pieSplat(self, x, y, z, sequence, pieCode, timestamp32):\n if self.isLocal():\n return\n elapsed = globalClock.getFrameTime() - self.lastTossedPie\n if elapsed > 30:\n return\n if not launcher.getPhaseComplete(5):\n return\n lastPieTrack = Sequence()\n if sequence in self.pieTracks:\n lastPieTrack = self.pieTracks[sequence]\n del self.pieTracks[sequence]\n if sequence in self.splatTracks:\n lastSplatTrack = self.splatTracks[sequence]\n del self.splatTracks[sequence]\n lastSplatTrack.finish()\n ts = globalClockDelta.localElapsedTime(timestamp32, bits=32)\n ts -= self.smoother.getDelay()\n splat = self.getPieSplatInterval(x, y, z, pieCode)\n splat = Sequence(Func(messenger.send, 'pieSplat', [self, pieCode]), splat)\n if ts > 0:\n startTime = ts\n lastPieTrack.finish()\n else:\n splat = Sequence(Wait(-ts), splat)\n startTime = 0\n splat = Sequence(splat, Func(self.pieFinishedSplatting, sequence))\n self.splatTracks[sequence] = splat\n splat.start(startTime)\n\n def cleanupPies(self):\n for track in self.pieTracks.values():\n track.finish()\n\n self.pieTracks = {}\n for track in self.splatTracks.values():\n track.finish()\n\n self.splatTracks = {}\n self.cleanupPieInHand()\n\n def cleanupPieInHand(self):\n if self.tossTrack:\n self.tossTrack.finish()\n self.tossTrack = None\n self.cleanupPieModel()\n return\n\n def setNumPies(self, numPies):\n self.numPies = numPies\n if self.isLocal():\n self.updatePieButton()\n if numPies == 0:\n self.interruptPie()\n\n def setPieType(self, pieType):\n self.pieType = pieType\n if self.isLocal():\n self.updatePieButton()\n\n def setTrophyScore(self, score):\n self.trophyScore = score\n if self.trophyStar != None:\n self.trophyStar.removeNode()\n self.trophyStar = None\n if self.trophyStarSpeed != 0:\n taskMgr.remove(self.uniqueName('starSpin'))\n self.trophyStarSpeed = 0\n if hasattr(self, 'gmIcon') and self.gmIcon:\n return\n if self.trophyScore >= ToontownGlobals.TrophyStarLevels[4]:\n self.trophyStar = loader.loadModel('phase_3.5/models/gui/name_star')\n np = NodePath(self.nametag.getIcon())\n self.trophyStar.reparentTo(np)\n self.trophyStar.setScale(2)\n self.trophyStar.setZ(2)\n self.trophyStar.setColor(ToontownGlobals.TrophyStarColors[4])\n self.trophyStarSpeed = 15\n if self.trophyScore >= ToontownGlobals.TrophyStarLevels[5]:\n taskMgr.add(self.__starSpin, self.uniqueName('starSpin'))\n elif self.trophyScore >= ToontownGlobals.TrophyStarLevels[2]:\n self.trophyStar = loader.loadModel('phase_3.5/models/gui/name_star')\n np = NodePath(self.nametag.getIcon())\n self.trophyStar.reparentTo(np)\n self.trophyStar.setScale(1.5)\n self.trophyStar.setZ(1.6)\n self.trophyStar.setColor(ToontownGlobals.TrophyStarColors[2])\n self.trophyStarSpeed = 10\n if self.trophyScore >= ToontownGlobals.TrophyStarLevels[3]:\n taskMgr.add(self.__starSpin, self.uniqueName('starSpin'))\n elif self.trophyScore >= ToontownGlobals.TrophyStarLevels[0]:\n self.trophyStar = loader.loadModel('phase_3.5/models/gui/name_star')\n np = NodePath(self.nametag.getIcon())\n self.trophyStar.reparentTo(np)\n self.trophyStar.setScale(1.5)\n self.trophyStar.setZ(1.6)\n self.trophyStar.setColor(ToontownGlobals.TrophyStarColors[0])\n self.trophyStarSpeed = 8\n if self.trophyScore >= ToontownGlobals.TrophyStarLevels[1]:\n taskMgr.add(self.__starSpin, self.uniqueName('starSpin'))\n return\n\n def __starSpin(self, task):\n now = globalClock.getFrameTime()\n r = now * self.trophyStarSpeed % 360.0\n self.trophyStar.setR(r)\n return Task.cont\n\n def getZoneId(self):\n place = base.cr.playGame.getPlace()\n if place:\n return place.getZoneId()\n else:\n return None\n return None\n\n def getRequestID(self):\n return CLIENT_GET_AVATAR_DETAILS\n\n def announceBingo(self):\n self.setChatAbsolute(TTLocalizer.FishBingoBingo, CFSpeech | CFTimeout)\n\n def squish(self, damage):\n if self == base.localAvatar:\n base.cr.playGame.getPlace().fsm.request('squished')\n self.stunToon()\n self.setZ(self.getZ(render) + 0.025)\n\n def d_squish(self, damage):\n self.sendUpdate('squish', [damage])\n\n def b_squish(self, damage):\n if not self.isStunned:\n self.squish(damage)\n self.d_squish(damage)\n self.playDialogueForString('!')\n\n def getShadowJoint(self):\n return Toon.Toon.getShadowJoint(self)\n\n if base.wantKarts:\n\n def hasKart(self):\n return self.kartDNA[KartDNA.bodyType] != -1\n\n def getKartDNA(self):\n return self.kartDNA\n\n def setTickets(self, numTickets):\n self.tickets = numTickets\n\n def getTickets(self):\n return self.tickets\n\n def getAccessoryByType(self, accType):\n return self.kartDNA[accType]\n\n def setCurrentKart(self, avId):\n self.kartId = avId\n\n def releaseKart(self):\n self.kartId = None\n return\n\n def setKartBodyType(self, bodyType):\n self.kartDNA[KartDNA.bodyType] = bodyType\n\n def getKartBodyType(self):\n return self.kartDNA[KartDNA.bodyType]\n\n def setKartBodyColor(self, bodyColor):\n self.kartDNA[KartDNA.bodyColor] = bodyColor\n\n def getKartBodyColor(self):\n return self.kartDNA[KartDNA.bodyColor]\n\n def setKartAccessoryColor(self, accColor):\n self.kartDNA[KartDNA.accColor] = accColor\n\n def getKartAccessoryColor(self):\n return self.kartDNA[KartDNA.accColor]\n\n def setKartEngineBlockType(self, ebType):\n self.kartDNA[KartDNA.ebType] = ebType\n\n def getKartEngineBlockType(self):\n return self.kartDNA[KartDNA.ebType]\n\n def setKartSpoilerType(self, spType):\n self.kartDNA[KartDNA.spType] = spType\n\n def getKartSpoilerType(self):\n return self.kartDNA[KartDNA.spType]\n\n def setKartFrontWheelWellType(self, fwwType):\n self.kartDNA[KartDNA.fwwType] = fwwType\n\n def getKartFrontWheelWellType(self):\n return self.kartDNA[KartDNA.fwwType]\n\n def setKartBackWheelWellType(self, bwwType):\n self.kartDNA[KartDNA.bwwType] = bwwType\n\n def getKartBackWheelWellType(self):\n return self.kartDNA[KartDNA.bwwType]\n\n def setKartRimType(self, rimsType):\n self.kartDNA[KartDNA.rimsType] = rimsType\n\n def setKartDecalType(self, decalType):\n self.kartDNA[KartDNA.decalType] = decalType\n\n def getKartDecalType(self):\n return self.kartDNA[KartDNA.decalType]\n\n def getKartRimType(self):\n return self.kartDNA[KartDNA.rimsType]\n\n def setKartAccessoriesOwned(self, accessories):\n while len(accessories) < 16:\n accessories.append(-1)\n\n self.accessories = accessories\n\n def getKartAccessoriesOwned(self):\n owned = copy.deepcopy(self.accessories)\n while InvalidEntry in owned:\n owned.remove(InvalidEntry)\n\n return owned\n\n def requestKartDNAFieldUpdate(self, dnaField, fieldValue):\n self.notify.debug('requestKartDNAFieldUpdate - dnaField %s, fieldValue %s' % (dnaField, fieldValue))\n self.sendUpdate('updateKartDNAField', [dnaField, fieldValue])\n\n def requestAddOwnedAccessory(self, accessoryId):\n self.notify.debug('requestAddOwnedAccessor - purchased accessory %s' % accessoryId)\n self.sendUpdate('addOwnedAccessory', [accessoryId])\n\n def requestRemoveOwnedAccessory(self, accessoryId):\n self.notify.debug('requestRemoveOwnedAccessor - removed accessory %s' % accessoryId)\n self.sendUpdate('removeOwnedAccessory', [accessoryId])\n\n def setKartingTrophies(self, trophyList):\n self.kartingTrophies = trophyList\n\n def getKartingTrophies(self):\n return self.kartingTrophies\n\n def setKartingHistory(self, history):\n self.kartingHistory = history\n\n def getKartingHistory(self):\n return self.kartingHistory\n\n def setKartingPersonalBest(self, bestTimes):\n self.kartingPersonalBest = bestTimes\n\n def getKartingPersonalBest(self):\n return self.kartingPersonalBest\n\n def setKartingPersonalBest2(self, bestTimes2):\n self.kartingPersonalBest2 = bestTimes2\n\n def getKartingPersonalBest2(self):\n return self.kartingPersonalBest2\n\n def getKartingPersonalBestAll(self):\n return self.kartingPersonalBest + self.kartingPersonalBest2\n\n if hasattr(base, 'wantPets') and base.wantPets:\n\n def setPetId(self, petId):\n self.petId = petId\n if petId == 0:\n self.petDNA = None\n elif self.isLocal():\n base.cr.addPetToFriendsMap()\n return\n\n def getPetId(self):\n return self.petId\n\n def getPetId(self):\n return self.petId\n\n def hasPet(self):\n return self.petId != 0\n\n def b_setPetTutorialDone(self, bDone):\n self.d_setPetTutorialDone(bDone)\n self.setPetTutorialDone(bDone)\n\n def d_setPetTutorialDone(self, bDone):\n self.sendUpdate('setPetTutorialDone', [bDone])\n\n def setPetTutorialDone(self, bDone):\n self.bPetTutorialDone = bDone\n\n def b_setFishBingoTutorialDone(self, bDone):\n self.d_setFishBingoTutorialDone(bDone)\n self.setFishBingoTutorialDone(bDone)\n\n def d_setFishBingoTutorialDone(self, bDone):\n self.sendUpdate('setFishBingoTutorialDone', [bDone])\n\n def setFishBingoTutorialDone(self, bDone):\n self.bFishBingoTutorialDone = bDone\n\n def b_setFishBingoMarkTutorialDone(self, bDone):\n self.d_setFishBingoMarkTutorialDone(bDone)\n self.setFishBingoMarkTutorialDone(bDone)\n\n def d_setFishBingoMarkTutorialDone(self, bDone):\n self.sendUpdate('setFishBingoMarkTutorialDone', [bDone])\n\n def setFishBingoMarkTutorialDone(self, bDone):\n self.bFishBingoMarkTutorialDone = bDone\n\n def b_setPetMovie(self, petId, flag):\n self.d_setPetMovie(petId, flag)\n self.setPetMovie(petId, flag)\n\n def d_setPetMovie(self, petId, flag):\n self.sendUpdate('setPetMovie', [petId, flag])\n\n def setPetMovie(self, petId, flag):\n pass\n\n def lookupPetDNA(self):\n if self.petId and not self.petDNA:\n from toontown.pets import PetDetail\n PetDetail.PetDetail(self.petId, self.__petDetailsLoaded)\n\n def __petDetailsLoaded(self, pet):\n self.petDNA = pet.style\n\n def trickOrTreatTargetMet(self, beanAmount):\n if self.effect:\n self.effect.stop()\n self.effect = TrickOrTreatTargetEffect(beanAmount)\n self.effect.play()\n\n def trickOrTreatMilestoneMet(self):\n if self.effect:\n self.effect.stop()\n self.effect = TrickOrTreatMilestoneEffect()\n self.effect.play()\n\n def winterCarolingTargetMet(self, beanAmount):\n if self.effect:\n self.effect.stop()\n self.effect = WinterCarolingEffect(beanAmount)\n self.effect.play()\n\n def d_reqCogSummons(self, type, suitIndex):\n if type == 'single':\n pass\n elif type == 'building':\n pass\n elif type == 'invasion':\n pass\n self.sendUpdate('reqCogSummons', [type, suitIndex])\n\n def cogSummonsResponse(self, returnCode, suitIndex, doId):\n messenger.send('cog-summons-response', [returnCode, suitIndex, doId])\n\n def setCogSummonsEarned(self, cogSummonsEarned):\n self.cogSummonsEarned = cogSummonsEarned\n\n def getCogSummonsEarned(self):\n return self.cogSummonsEarned\n\n def hasCogSummons(self, suitIndex, type = None):\n summons = self.getCogSummonsEarned()\n curSetting = summons[suitIndex]\n if type == 'single':\n return curSetting & 1\n elif type == 'building':\n return curSetting & 2\n elif type == 'invasion':\n return curSetting & 4\n return curSetting\n\n def setFlowerCollection(self, speciesList, varietyList):\n self.flowerCollection = FlowerCollection.FlowerCollection()\n self.flowerCollection.makeFromNetLists(speciesList, varietyList)\n\n def getFlowerCollection(self):\n return self.flowerCollection\n\n def setMaxFlowerBasket(self, maxFlowerBasket):\n self.maxFlowerBasket = maxFlowerBasket\n\n def getMaxFlowerBasket(self):\n return self.maxFlowerBasket\n\n def isFlowerBasketFull(self):\n return len(self.flowerBasket) >= self.maxFlowerBasket\n\n def setFlowerBasket(self, speciesList, varietyList):\n self.flowerBasket = FlowerBasket.FlowerBasket()\n self.flowerBasket.makeFromNetLists(speciesList, varietyList)\n messenger.send('flowerBasketUpdated')\n\n def getFlowerBasket(self):\n return self.flowerBasket\n\n def setShovel(self, shovelId):\n self.shovel = shovelId\n\n def attachShovel(self):\n self.shovelModel = self.getShovelModel()\n self.shovelModel.reparentTo(self.rightHand)\n return self.shovelModel\n\n def detachShovel(self):\n if self.shovelModel:\n self.shovelModel.removeNode()\n\n def getShovelModel(self):\n shovels = loader.loadModel('phase_5.5/models/estate/shovels')\n shovelId = ['A',\n 'B',\n 'C',\n 'D'][self.shovel]\n shovel = shovels.find('**/shovel' + shovelId)\n shovel.setH(-90)\n shovel.setP(216)\n shovel.setX(0.2)\n shovel.detachNode()\n shovels.removeNode()\n return shovel\n\n def setShovelSkill(self, skillLevel):\n self.shovelSkill = skillLevel\n\n def getBoxCapability(self):\n return GardenGlobals.getShovelPower(self.shovel, self.shovelSkill)\n\n def setWateringCan(self, wateringCanId):\n self.wateringCan = wateringCanId\n\n def attachWateringCan(self):\n self.wateringCanModel = self.getWateringCanModel()\n self.wateringCanModel.reparentTo(self.rightHand)\n return self.wateringCanModel\n\n def detachWateringCan(self):\n if self.wateringCanModel:\n self.wateringCanModel.removeNode()\n\n def getWateringCanModel(self):\n scalePosHprsTable = ((0.25, 0.1, 0, 0.2, -90, -125, -45),\n (0.2, 0.0, 0.25, 0.2, -90, -125, -45),\n (0.2, 0.2, 0.1, 0.2, -90, -125, -45),\n (0.2, 0.0, 0.25, 0.2, -90, -125, -45))\n cans = loader.loadModel('phase_5.5/models/estate/watering_cans')\n canId = ['A',\n 'B',\n 'C',\n 'D'][self.wateringCan]\n can = cans.find('**/water_can' + canId)\n can.setScale(scalePosHprsTable[self.wateringCan][0])\n can.setPos(scalePosHprsTable[self.wateringCan][1], scalePosHprsTable[self.wateringCan][2], scalePosHprsTable[self.wateringCan][3])\n can.setHpr(scalePosHprsTable[self.wateringCan][4], scalePosHprsTable[self.wateringCan][5], scalePosHprsTable[self.wateringCan][6])\n can.detachNode()\n cans.removeNode()\n if hasattr(base, 'rwc'):\n if base.rwc:\n if hasattr(self, 'wateringCan2'):\n self.wateringCan2.removeNode()\n self.wateringCan2 = can.copyTo(self.rightHand)\n else:\n self.wateringCan2.removeNode()\n return can\n\n def setWateringCanSkill(self, skillLevel):\n self.wateringCanSkill = skillLevel\n\n def setGardenSpecials(self, specials):\n self.gardenSpecials = specials\n if hasattr(self, 'gardenPage') and self.gardenPage:\n self.gardenPage.updatePage()\n\n def getGardenSpecials(self):\n return self.gardenSpecials\n\n def getMyTrees(self):\n treeDict = self.cr.getObjectsOfClass(DistributedGagTree.DistributedGagTree)\n trees = []\n for tree in treeDict.values():\n if tree.getOwnerId() == self.doId:\n trees.append(tree)\n\n if not trees:\n pass\n return trees\n\n def isTreePlanted(self, track, level):\n trees = self.getMyTrees()\n for tree in trees:\n if tree.gagTrack == track and tree.gagLevel == level:\n return True\n\n return False\n\n def doIHaveRequiredTrees(self, track, level):\n trees = self.getMyTrees()\n trackAndLevelList = []\n for tree in trees:\n trackAndLevelList.append((tree.gagTrack, tree.gagLevel))\n\n haveRequired = True\n for curLevel in xrange(level):\n testTuple = (track, curLevel)\n if testTuple not in trackAndLevelList:\n haveRequired = False\n break\n\n return haveRequired\n\n def setTrackBonusLevel(self, trackArray):\n self.trackBonusLevel = trackArray\n if self.inventory:\n self.inventory.updateGUI()\n\n def getTrackBonusLevel(self, track = None):\n if track == None:\n return self.trackBonusLevel\n else:\n return self.trackBonusLevel[track]\n return\n\n def checkGagBonus(self, track, level):\n trackBonus = self.getTrackBonusLevel(track)\n return trackBonus >= level\n\n def setGardenTrophies(self, trophyList):\n self.gardenTrophies = trophyList\n\n def getGardenTrophies(self):\n return self.gardenTrophies\n\n def useSpecialResponse(self, returnCode):\n messenger.send('use-special-response', [returnCode])\n\n def setGardenStarted(self, bStarted):\n self.gardenStarted = bStarted\n\n def getGardenStarted(self):\n return self.gardenStarted\n\n def sendToGolfCourse(self, zoneId):\n hoodId = self.cr.playGame.hood.hoodId\n golfRequest = {'loader': 'safeZoneLoader',\n 'where': 'golfcourse',\n 'how': 'teleportIn',\n 'hoodId': hoodId,\n 'zoneId': zoneId,\n 'shardId': None,\n 'avId': -1}\n base.cr.playGame.getPlace().requestLeave(golfRequest)\n return\n\n def getGolfTrophies(self):\n return self.golfTrophies\n\n def getGolfCups(self):\n return self.golfCups\n\n def setGolfHistory(self, history):\n self.golfHistory = history\n self.golfTrophies = GolfGlobals.calcTrophyListFromHistory(self.golfHistory)\n self.golfCups = GolfGlobals.calcCupListFromHistory(self.golfHistory)\n if hasattr(self, 'book'):\n self.addGolfPage()\n\n def getGolfHistory(self):\n return self.golfHistory\n\n def hasPlayedGolf(self):\n retval = False\n for historyValue in self.golfHistory:\n if historyValue:\n retval = True\n break\n\n return retval\n\n def setPackedGolfHoleBest(self, packedHoleBest):\n unpacked = GolfGlobals.unpackGolfHoleBest(packedHoleBest)\n self.setGolfHoleBest(unpacked)\n\n def setGolfHoleBest(self, holeBest):\n self.golfHoleBest = holeBest\n\n def getGolfHoleBest(self):\n return self.golfHoleBest\n\n def setGolfCourseBest(self, courseBest):\n self.golfCourseBest = courseBest\n\n def getGolfCourseBest(self):\n return self.golfCourseBest\n\n def setUnlimitedSwing(self, unlimitedSwing):\n self.unlimitedSwing = unlimitedSwing\n\n def getUnlimitedSwing(self):\n return self.unlimitedSwing\n\n def getPinkSlips(self):\n if hasattr(self, 'pinkSlips'):\n return self.pinkSlips\n else:\n return 0\n\n def setPinkSlips(self, pinkSlips):\n self.pinkSlips = pinkSlips\n\n def setAccess(self, access):\n self.setGameAccess(access)\n self.setDisplayName(self.getName())\n\n def setGameAccess(self, access):\n self.gameAccess = access\n\n def getGameAccess(self):\n if hasattr(self, 'gameAccess'):\n return self.gameAccess\n else:\n return 0\n\n def setDisplayName(self, str):\n if self.getGameAccess() == OTPGlobals.AccessFull and not self.isDisguised:\n self.setFancyNametag(name=str)\n else:\n self.removeFancyNametag()\n Avatar.Avatar.setDisplayName(self, str)\n\n def setFancyNametag(self, name=None):\n if name is None:\n name = self.getName()\n if self.getNametagStyle() >= len(TTLocalizer.NametagFonts):\n self.nametag.setFont(ToontownGlobals.getToonFont())\n else:\n self.nametag.setFont(ToontownGlobals.getNametagFont(self.getNametagStyle()))\n Avatar.Avatar.setDisplayName(self, name)\n\n def removeFancyNametag(self):\n self.nametag.clearShadow()\n\n def getNametagStyle(self):\n if hasattr(self, 'nametagStyle'):\n return self.nametagStyle\n else:\n return 0\n\n def setNametagStyle(self, nametagStyle):\n if hasattr(self, 'gmToonLockStyle') and self.gmToonLockStyle:\n return\n if base.config.GetBool('want-nametag-avids', 0):\n nametagStyle = 0\n self.nametagStyle = nametagStyle\n self.setDisplayName(self.getName())\n\n def getAvIdName(self):\n paidStr = PythonUtil.choice(self.getGameAccess() == OTPGlobals.AccessFull, 'P', 'F')\n return '%s\\n%s (%s)' % (self.getName(), self.doId, paidStr)\n\n def playCurrentDialogue(self, dialogue, chatFlags, interrupt = 1):\n if interrupt and self.__currentDialogue is not None:\n self.__currentDialogue.stop()\n self.__currentDialogue = dialogue\n if dialogue:\n base.playSfx(dialogue, node=self)\n elif chatFlags & CFSpeech != 0:\n if self.nametag.getNumChatPages() > 0:\n self.playDialogueForString(self.nametag.getChatText())\n if self.soundChatBubble != None:\n base.playSfx(self.soundChatBubble, node=self)\n elif self.nametag.getStompChatText():\n self.playDialogueForString(self.nametag.getStompChatText(), self.nametag.CHAT_STOMP_DELAY)\n\n def playDialogueForString(self, chatString, delay = 0.0):\n if len(chatString) == 0:\n return\n searchString = chatString.lower()\n if searchString.find(OTPLocalizer.DialogSpecial) >= 0:\n type = 'special'\n elif searchString.find(OTPLocalizer.DialogExclamation) >= 0:\n type = 'exclamation'\n elif searchString.find(OTPLocalizer.DialogQuestion) >= 0:\n type = 'question'\n elif random.randint(0, 1):\n type = 'statementA'\n else:\n type = 'statementB'\n stringLength = len(chatString)\n if stringLength <= OTPLocalizer.DialogLength1:\n length = 1\n elif stringLength <= OTPLocalizer.DialogLength2:\n length = 2\n elif stringLength <= OTPLocalizer.DialogLength3:\n length = 3\n else:\n length = 4\n self.playDialogue(type, length, delay)\n\n def playDialogue(self, type, length, delay = 0.0):\n dialogueArray = self.getDialogueArray()\n if dialogueArray == None:\n return\n sfxIndex = None\n if type == 'statementA' or type == 'statementB':\n if length == 1:\n sfxIndex = 0\n elif length == 2:\n sfxIndex = 1\n elif length >= 3:\n sfxIndex = 2\n elif type == 'question':\n sfxIndex = 3\n elif type == 'exclamation':\n sfxIndex = 4\n elif type == 'special':\n sfxIndex = 5\n else:\n self.notify.error('unrecognized dialogue type: ', type)\n if sfxIndex != None and sfxIndex < len(dialogueArray) and dialogueArray[sfxIndex] != None:\n soundSequence = Sequence(Wait(delay), SoundInterval(dialogueArray[sfxIndex], node=None, listenerNode=base.localAvatar, loop=0, volume=1.0))\n self.soundSequenceList.append(soundSequence)\n soundSequence.start()\n self.cleanUpSoundList()\n return\n\n def cleanUpSoundList(self):\n removeList = []\n for soundSequence in self.soundSequenceList:\n if soundSequence.isStopped():\n removeList.append(soundSequence)\n\n for soundSequence in removeList:\n self.soundSequenceList.remove(soundSequence)\n\n def sendLogMessage(self, message):\n self.sendUpdate('logMessage', [message])\n\n def setChatAbsolute(self, chatString, chatFlags, dialogue = None, interrupt = 1, quiet = 0):\n DistributedAvatar.DistributedAvatar.setChatAbsolute(self, chatString, chatFlags, dialogue, interrupt)\n\n def setChatMuted(self, chatString, chatFlags, dialogue=None, interrupt=1, quiet=0):\n if chatFlags & CFQuicktalker:\n self.nametag.setChatType(NametagGlobals.SPEEDCHAT)\n elif chatFlags & CFSpeech:\n self.nametag.setChatType(NametagGlobals.CHAT)\n\n if chatFlags & CFThought:\n self.nametag.setChatBalloonType(NametagGlobals.THOUGHT_BALLOON)\n else:\n self.nametag.setChatBalloonType(NametagGlobals.CHAT_BALLOON)\n\n if chatFlags & CFPageButton:\n self.nametag.setChatButton(NametagGlobals.pageButton)\n elif chatFlags & CFQuitButton:\n self.nametag.setChatButton(NametagGlobals.quitButton)\n else:\n self.nametag.setChatButton(NametagGlobals.noButton)\n\n self.nametag.setChatText(chatString, timeout=bool(chatFlags & CFTimeout))\n self.playCurrentDialogue(dialogue, chatFlags - CFSpeech, interrupt)\n\n def displayTalk(self, chatString, mods=None):\n flags = CFSpeech | CFTimeout\n self.nametag.setChatType(NametagGlobals.CHAT)\n if base.talkAssistant.isThought(chatString):\n flags = CFThought\n self.nametag.setChatBalloonType(NametagGlobals.THOUGHT_BALLOON)\n chatString = base.talkAssistant.removeThoughtPrefix(chatString)\n else:\n self.nametag.setChatBalloonType(NametagGlobals.CHAT_BALLOON)\n self.nametag.setChatText(chatString, timeout=(flags & CFTimeout))\n if base.toonChatSounds:\n self.playCurrentDialogue(None, flags, interrupt=1)\n\n def setMail(self, mail):\n DistributedToon.partyNotify.debug('setMail called with %d mail items' % len(mail))\n self.mail = []\n for i in xrange(len(mail)):\n oneMailItem = mail[i]\n newMail = SimpleMailBase(*oneMailItem)\n self.mail.append(newMail)\n\n def setSimpleMailNotify(self, simpleMailNotify):\n DistributedToon.partyNotify.debug('setSimpleMailNotify( %s )' % simpleMailNotify)\n self.simpleMailNotify = simpleMailNotify\n if self.isLocal():\n self.gotCatalogNotify = 1\n self.refreshOnscreenButtons()\n\n def setInviteMailNotify(self, inviteMailNotify):\n DistributedToon.partyNotify.debug('setInviteMailNotify( %s )' % inviteMailNotify)\n self.inviteMailNotify = inviteMailNotify\n if self.isLocal():\n self.gotCatalogNotify = 1\n self.refreshOnscreenButtons()\n\n def setInvites(self, invites):\n DistributedToon.partyNotify.debug('setInvites called passing in %d invites.' % len(invites))\n self.invites = []\n for i in xrange(len(invites)):\n oneInvite = invites[i]\n newInvite = InviteInfo(*oneInvite)\n self.invites.append(newInvite)\n\n def updateInviteMailNotify(self):\n invitesInMailbox = self.getInvitesToShowInMailbox()\n newInvites = 0\n readButNotRepliedInvites = 0\n for invite in invitesInMailbox:\n if invite.status == PartyGlobals.InviteStatus.NotRead:\n newInvites += 1\n elif invite.status == PartyGlobals.InviteStatus.ReadButNotReplied:\n readButNotRepliedInvites += 1\n if __dev__:\n partyInfo = self.getOnePartyInvitedTo(invite.partyId)\n if not partyInfo:\n self.notify.error('party info not found in partiesInvtedTo, partyId = %s' % str(invite.partyId))\n\n if newInvites:\n self.setInviteMailNotify(ToontownGlobals.NewItems)\n elif readButNotRepliedInvites:\n self.setInviteMailNotify(ToontownGlobals.OldItems)\n else:\n self.setInviteMailNotify(ToontownGlobals.NoItems)\n\n def getInvitesToShowInMailbox(self):\n result = []\n for invite in self.invites:\n appendInvite = True\n if invite.status == InviteStatus.Accepted or invite.status == InviteStatus.Rejected:\n appendInvite = False\n if appendInvite:\n partyInfo = self.getOnePartyInvitedTo(invite.partyId)\n if not partyInfo:\n appendInvite = False\n if appendInvite:\n if partyInfo.status == PartyGlobals.PartyStatus.Cancelled:\n appendInvite = False\n if appendInvite:\n endDate = partyInfo.endTime.date()\n curDate = base.cr.toontownTimeManager.getCurServerDateTime().date()\n if endDate < curDate:\n appendInvite = False\n if appendInvite:\n result.append(invite)\n\n return result\n\n def getNumInvitesToShowInMailbox(self):\n result = len(self.getInvitesToShowInMailbox())\n return result\n\n def setHostedParties(self, hostedParties):\n DistributedToon.partyNotify.debug('setHostedParties called passing in %d parties.' % len(hostedParties))\n self.hostedParties = []\n for i in xrange(len(hostedParties)):\n hostedInfo = hostedParties[i]\n newParty = PartyInfo(*hostedInfo)\n self.hostedParties.append(newParty)\n\n def setPartiesInvitedTo(self, partiesInvitedTo):\n DistributedToon.partyNotify.debug('setPartiesInvitedTo called passing in %d parties.' % len(partiesInvitedTo))\n self.partiesInvitedTo = []\n for i in xrange(len(partiesInvitedTo)):\n partyInfo = partiesInvitedTo[i]\n newParty = PartyInfo(*partyInfo)\n self.partiesInvitedTo.append(newParty)\n\n self.updateInviteMailNotify()\n\n def getOnePartyInvitedTo(self, partyId):\n result = None\n for i in xrange(len(self.partiesInvitedTo)):\n partyInfo = self.partiesInvitedTo[i]\n if partyInfo.partyId == partyId:\n result = partyInfo\n break\n\n return result\n\n def getInviteForPartyId(self, partyId):\n result = None\n for invite in self.invites:\n if invite.partyId == partyId:\n result = invite\n break\n\n return result\n\n def setPartyReplies(self, replies):\n DistributedToon.partyNotify.debug('setPartyReplies called passing in %d parties.' % len(replies))\n self.partyReplyInfoBases = []\n for i in xrange(len(replies)):\n partyReply = replies[i]\n repliesForOneParty = PartyReplyInfoBase(*partyReply)\n self.partyReplyInfoBases.append(repliesForOneParty)\n\n def setPartyCanStart(self, partyId):\n DistributedToon.partyNotify.debug('setPartyCanStart called passing in partyId=%s' % partyId)\n for partyInfo in self.hostedParties:\n if partyInfo.partyId == partyId:\n partyInfo.status = PartyGlobals.PartyStatus.CanStart\n from toontown.shtiker import EventsPage\n if hasattr(self, 'eventsPage') and base.localAvatar.book.entered and base.localAvatar.book.isOnPage(self.eventsPage) and self.eventsPage.getMode() == EventsPage.EventsPage_Host:\n base.localAvatar.eventsPage.loadHostedPartyInfo()\n if hasattr(self, 'displaySystemClickableWhisper'):\n self.displaySystemClickableWhisper(0, TTLocalizer.PartyCanStart, whisperType=WTSystem)\n else:\n self.setSystemMessage(0, TTLocalizer.PartyCanStart)\n\n def setPartyStatus(self, partyId, newStatus):\n DistributedToon.partyNotify.debug('setPartyCanStatus called passing in partyId=%s status=%s' % (partyId, newStatus))\n found = False\n for partyInfo in self.hostedParties:\n if partyInfo.partyId == partyId:\n partyInfo.status = newStatus\n found = True\n break\n\n for partyInfo in self.partiesInvitedTo:\n if partyInfo.partyId == partyId:\n partyInfo.status = newStatus\n found = True\n from toontown.shtiker import EventsPage\n if hasattr(self, 'eventsPage') and base.localAvatar.book.entered and base.localAvatar.book.isOnPage(self.eventsPage) and self.eventsPage.getMode() == EventsPage.EventsPage_Invited:\n base.localAvatar.eventsPage.loadInvitations()\n if newStatus == PartyStatus.Started and hasattr(self, 'displaySystemClickableWhisper'):\n invite = self.getInviteForPartyId(partyId)\n if invite:\n name = ' '\n host = base.cr.identifyAvatar(partyInfo.hostId)\n if host:\n name = host.getName()\n if invite.status == InviteStatus.Accepted:\n displayStr = TTLocalizer.PartyHasStartedAcceptedInvite % TTLocalizer.GetPossesive(name)\n self.displaySystemClickableWhisper(-1, displayStr, whisperType=WTSystem)\n else:\n displayStr = TTLocalizer.PartyHasStartedNotAcceptedInvite % TTLocalizer.GetPossesive(name)\n self.setSystemMessage(partyInfo.hostId, displayStr, whisperType=WTSystem)\n break\n\n if not found:\n self.notify.warning(\"setPartyCanStart can't find partyId=% status=%d\" % (partyId, newStatus))\n\n def announcePartyStarted(self, partyId):\n DistributedToon.partyNotify.debug('announcePartyStarted')\n return\n for partyReplyInfo in self.partyReplyInfoBases:\n if partyReplyInfo.partyId == partyId:\n for singleReply in partyReplyInfo.replies:\n toonId = singleReply.inviteeId\n if base.cr.isFriend(toonId):\n if base.cr.isFriendOnline(toonId):\n if singleReply.status == InviteStatus.Accepted:\n self.whisperSCTo(5302, toonId, 0)\n else:\n self.whisperSCTo(5302, toonId, 0)\n\n def updateInvite(self, inviteKey, newStatus):\n DistributedToon.partyNotify.debug('updateInvite( inviteKey=%d, newStatus=%s )' % (inviteKey, InviteStatus.getString(newStatus)))\n for invite in self.invites:\n if invite.inviteKey == inviteKey:\n invite.status = newStatus\n self.updateInviteMailNotify()\n break\n\n def updateReply(self, partyId, inviteeId, newStatus):\n DistributedToon.partyNotify.debug('updateReply( partyId=%d, inviteeId=%d, newStatus=%s )' % (partyId, inviteeId, InviteStatus.getString(newStatus)))\n for partyReplyInfoBase in self.partyReplyInfoBases:\n if partyReplyInfoBase.partyId == partyId:\n for reply in partyReplyInfoBase.replies:\n if reply.inviteeId == inviteeId:\n reply.status = newStatus\n break\n\n def scrubTalk(self, message, mods):\n scrubbed = 0\n text = copy.copy(message)\n for mod in mods:\n index = mod[0]\n length = mod[1] - mod[0] + 1\n newText = text[0:index] + length * '\\x07' + text[index + length:]\n text = newText\n\n words = text.split(' ')\n newwords = []\n for word in words:\n if word == '':\n newwords.append(word)\n elif word[0] == '\\x07' or len(word) > 1 and word[0] == '.' and word[1] == '\\x07':\n newwords.append('\\x01WLDisplay\\x01' + self.chatGarbler.garbleSingle(self, word) + '\\x02')\n scrubbed = 1\n elif not self.whiteListEnabled or base.whiteList.isWord(word):\n newwords.append(word)\n else:\n flag = 0\n for friendId, flags in self.friendsList:\n if not flags & ToontownGlobals.FriendChat:\n flag = 1\n\n if flag:\n scrubbed = 1\n newwords.append('\\x01WLDisplay\\x01' + word + '\\x02')\n else:\n newwords.append(word)\n\n newText = ' '.join(newwords)\n return (newText, scrubbed)\n\n def replaceBadWords(self, text):\n words = text.split(' ')\n newwords = []\n for word in words:\n if word == '':\n newwords.append(word)\n elif word[0] == '\\x07':\n newwords.append('\\x01WLRed\\x01' + self.chatGarbler.garbleSingle(self, word) + '\\x02')\n elif not self.whiteListEnabled or base.whiteList.isWord(word):\n newwords.append(word)\n else:\n newwords.append('\\x01WLRed\\x01' + word + '\\x02')\n\n newText = ' '.join(newwords)\n return newText\n\n def toonUp(self, hpGained, hasInteractivePropBonus = False):\n if self.hp == None or hpGained < 0:\n return\n oldHp = self.hp\n if self.hp + hpGained <= 0:\n self.hp += hpGained\n else:\n self.hp = min(max(self.hp, 0) + hpGained, self.maxHp)\n hpGained = self.hp - max(oldHp, 0)\n if hpGained > 0:\n self.showHpText(hpGained, hasInteractivePropBonus=hasInteractivePropBonus)\n self.hpChange(quietly=0)\n return\n\n def showHpText(self, number, bonus = 0, scale = 1, hasInteractivePropBonus = False):\n if self.HpTextEnabled and not self.ghostMode:\n if number != 0:\n if self.hpText:\n self.hideHpText()\n self.HpTextGenerator.setFont(OTPGlobals.getSignFont())\n if number < 0:\n self.HpTextGenerator.setText(str(number))\n else:\n hpGainedStr = '+' + str(number)\n if hasInteractivePropBonus:\n hpGainedStr += '\\n' + TTLocalizer.InteractivePropTrackBonusTerms[0]\n self.HpTextGenerator.setText(hpGainedStr)\n self.HpTextGenerator.clearShadow()\n self.HpTextGenerator.setAlign(TextNode.ACenter)\n if bonus == 1:\n r = 1.0\n g = 1.0\n b = 0\n a = 1\n elif bonus == 2:\n r = 1.0\n g = 0.5\n b = 0\n a = 1\n elif number < 0:\n r = 0.9\n g = 0\n b = 0\n a = 1\n else:\n r = 0\n g = 0.9\n b = 0\n a = 1\n self.HpTextGenerator.setTextColor(r, g, b, a)\n self.hpTextNode = self.HpTextGenerator.generate()\n self.hpText = self.attachNewNode(self.hpTextNode)\n self.hpText.setScale(scale)\n self.hpText.setBillboardPointEye()\n self.hpText.setBin('fixed', 100)\n self.hpText.setPos(0, 0, self.height / 2)\n seq = Sequence(self.hpText.posInterval(1.0, Point3(0, 0, self.height + 1.5), blendType='easeOut'), Wait(0.85), self.hpText.colorInterval(0.1, Vec4(r, g, b, 0)), Func(self.hideHpText))\n seq.start()\n\n def setName(self, name = 'unknownDistributedAvatar'):\n DistributedPlayer.DistributedPlayer.setName(self, name)\n self._handleGMName()\n\n def _handleGMName(self):\n name = self.name\n self.setDisplayName(name)\n if self._isGM:\n self.setGMIcon(self._gmType)\n self.gmToonLockStyle = False\n else:\n self.gmToonLockStyle = False\n self.removeGMIcon()\n\n def setGMIcon(self, gmType=None):\n if hasattr(self, 'gmIcon') and self.gmIcon:\n return\n if not gmType:\n gmType = self._gmType\n icons = loader.loadModel('phase_3/models/props/gm_icons.bam')\n searchString = '**/access_level_' + str(gmType)\n self.gmIcon = icons.find(searchString)\n np = NodePath(self.nametag.getIcon())\n if np.isEmpty():\n return\n self.gmIcon.flattenStrong()\n self.gmIcon.reparentTo(np)\n self.gmIcon.setScale(1.6)\n self.gmIcon.setZ(2.05)\n self.setTrophyScore(self.trophyScore)\n self.gmIconInterval = LerpHprInterval(self.gmIcon, 3.0, Point3(0, 0, 0), Point3(-360, 0, 0))\n self.gmIconInterval.loop()\n\n def setGMPartyIcon(self):\n gmType = self._gmType\n iconInfo = ('phase_3.5/models/gui/tt_m_gui_gm_toonResistance_fist', 'phase_3.5/models/gui/tt_m_gui_gm_toontroop_whistle', 'phase_3.5/models/gui/tt_m_gui_gm_toonResistance_fist', 'phase_3.5/models/gui/tt_m_gui_gm_toontroop_getConnected')\n if gmType > len(iconInfo) - 1:\n return\n self.gmIcon = loader.loadModel(iconInfo[gmType])\n self.gmIcon.reparentTo(NodePath(self.nametag.getIcon()))\n self.gmIcon.setScale(3.25)\n self.setTrophyScore(self.trophyScore)\n self.gmIcon.setZ(1.0)\n self.gmIcon.setY(0.0)\n self.gmIcon.setColor(Vec4(1.0, 1.0, 1.0, 1.0))\n self.gmIcon.setTransparency(1)\n self.gmIconInterval = LerpHprInterval(self.gmIcon, 3.0, Point3(0, 0, 0), Point3(-360, 0, 0))\n self.gmIconInterval.loop()\n\n def removeGMIcon(self):\n if hasattr(self, 'gmIconInterval') and self.gmIconInterval:\n self.gmIconInterval.finish()\n del self.gmIconInterval\n if hasattr(self, 'gmIcon') and self.gmIcon:\n self.gmIcon.detachNode()\n del self.gmIcon\n\n def setAnimalSound(self, index):\n self.animalSound = index\n\n def setAchievements(self, achievements):\n self.achievements = achievements\n messenger.send(localAvatar.uniqueName('achievementsChange'))\n\n def setBuffs(self, buffs):\n self.buffs = buffs\n self.applyBuffs()\n\n def applyBuffs(self):\n for id, timestamp in enumerate(self.buffs):\n if id == ToontownGlobals.BMovementSpeed:\n if not timestamp:\n return\n if self.zoneId is None:\n return\n if ZoneUtil.isDynamicZone(self.zoneId):\n return\n if ZoneUtil.getWhereName(self.zoneId, True) not in ('playground', 'street', 'toonInterior', 'cogHQExterior', 'factoryExterior'):\n return\n self.controlManager.setSpeeds(\n ToontownGlobals.ToonForwardSpeed * ToontownGlobals.BMovementSpeedMultiplier,\n ToontownGlobals.ToonJumpForce,\n ToontownGlobals.ToonReverseSpeed * ToontownGlobals.BMovementSpeedMultiplier,\n ToontownGlobals.ToonRotateSpeed * ToontownGlobals.BMovementSpeedMultiplier)\n\n@magicWord(category=CATEGORY_COMMUNITY_MANAGER)\ndef globalTeleport():\n \"\"\"\n Activates the global teleport cheat.\n \"\"\"\n invoker = spellbook.getInvoker()\n invoker.sendUpdate('setTeleportOverride', [1])\n invoker.setTeleportAccess(list(ToontownGlobals.HoodsForTeleportAll))\n return 'Global teleport has been activated.'\n\n@magicWord(category=CATEGORY_ADMINISTRATOR, types=[int])\ndef zone(zoneId):\n \"\"\"\n Changes the invoker's zone ID.\n \"\"\"\n base.cr.sendSetZoneMsg(zoneId, [zoneId])\n return 'You have been moved to zone %d.' % zoneId\n\n@magicWord(category=CATEGORY_ADMINISTRATOR, types=[int])\ndef promote(deptIndex):\n \"\"\"\n sends a request to promote the invoker's [deptIndex] Cog disguise.\n \"\"\"\n invoker = spellbook.getInvoker()\n invoker.sendUpdate('requestPromotion', [deptIndex])\n return 'Your promotion request has been sent.'\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227995,"cells":{"text":{"kind":"string","value":"\"\"\"Pexpect is a Python module for spawning child applications and controlling\nthem automatically. Pexpect can be used for automating interactive applications\nsuch as ssh, ftp, passwd, telnet, etc. It can be used to a automate setup\nscripts for duplicating software package installations on different servers. It\ncan be used for automated software testing. Pexpect is in the spirit of Don\nLibes' Expect, but Pexpect is pure Python. Other Expect-like modules for Python\nrequire TCL and Expect or require C extensions to be compiled. Pexpect does not\nuse C, Expect, or TCL extensions. It should work on any platform that supports\nthe standard Python pty module. The Pexpect interface focuses on ease of use so\nthat simple tasks are easy.\n\nThere are two main interfaces to the Pexpect system; these are the function,\nrun() and the class, spawn. The spawn class is more powerful. The run()\nfunction is simpler than spawn, and is good for quickly calling program. When\nyou call the run() function it executes a given program and then returns the\noutput. This is a handy replacement for os.system().\n\nFor example::\n\n pexpect.run('ls -la')\n\nThe spawn class is the more powerful interface to the Pexpect system. You can\nuse this to spawn a child program then interact with it by sending input and\nexpecting responses (waiting for patterns in the child's output).\n\nFor example::\n\n child = pexpect.spawn('scp foo myname@host.example.com:.')\n child.expect ('Password:')\n child.sendline (mypassword)\n\nThis works even for commands that ask for passwords or other input outside of\nthe normal stdio streams. For example, ssh reads input directly from the TTY\ndevice which bypasses stdin.\n\nCredits: Noah Spurrier, Richard Holden, Marco Molteni, Kimberley Burchett,\nRobert Stone, Hartmut Goebel, Chad Schroeder, Erick Tryzelaar, Dave Kirby, Ids\nvander Molen, George Todd, Noel Taylor, Nicolas D. Cesar, Alexander Gattin,\nJacques-Etienne Baudoux, Geoffrey Marshall, Francisco Lourenco, Glen Mabey,\nKarthik Gurusamy, Fernando Perez, Corey Minyard, Jon Cohen, Guillaume\nChazarain, Andrew Ryan, Nick Craig-Wood, Andrew Stone, Jorgen Grahn, John\nSpiegel, Jan Grant, and Shane Kerr. Let me know if I forgot anyone.\n\nPexpect is free, open source, and all that good stuff.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\nPexpect Copyright (c) 2010 Noah Spurrier\nhttp://pexpect.sourceforge.net/\n\n$Id$\n\"\"\"\n\ntry:\n import os, sys, time\n import select\n import string\n import re\n import struct\n import resource\n import types\n import pty\n import tty\n import termios\n import fcntl\n import errno\n import traceback\n import signal\nexcept ImportError, e:\n raise ImportError (str(e) + \"\"\"\n\nA critical module was not found. Probably this operating system does not\nsupport it. Pexpect is intended for UNIX-like operating systems.\"\"\")\n\n__version__ = '2.6'\n__revision__ = '$Revision$'\n__all__ = ['ExceptionPexpect', 'EOF', 'TIMEOUT', 'spawn', 'run', 'which',\n 'split_command_line', '__version__', '__revision__']\n\n# Exception classes used by this module.\nclass ExceptionPexpect(Exception):\n\n \"\"\"Base class for all exceptions raised by this module.\n \"\"\"\n\n def __init__(self, value):\n\n self.value = value\n\n def __str__(self):\n\n return str(self.value)\n\n def get_trace(self):\n\n \"\"\"This returns an abbreviated stack trace with lines that only concern\n the caller. In other words, the stack trace inside the Pexpect module\n is not included. \"\"\"\n\n tblist = traceback.extract_tb(sys.exc_info()[2])\n #tblist = filter(self.__filter_not_pexpect, tblist)\n tblist = [item for item in tblist if self.__filter_not_pexpect(item)]\n tblist = traceback.format_list(tblist)\n return ''.join(tblist)\n\n def __filter_not_pexpect(self, trace_list_item):\n\n \"\"\"This returns True if list item 0 the string 'pexpect.py' in it. \"\"\"\n\n if trace_list_item[0].find('pexpect.py') == -1:\n return True\n else:\n return False\n\nclass EOF(ExceptionPexpect):\n\n \"\"\"Raised when EOF is read from a child. This usually means the child has exited.\"\"\"\n\nclass TIMEOUT(ExceptionPexpect):\n\n \"\"\"Raised when a read time exceeds the timeout. \"\"\"\n\n##class TIMEOUT_PATTERN(TIMEOUT):\n## \"\"\"Raised when the pattern match time exceeds the timeout.\n## This is different than a read TIMEOUT because the child process may\n## give output, thus never give a TIMEOUT, but the output\n## may never match a pattern.\n## \"\"\"\n##class MAXBUFFER(ExceptionPexpect):\n## \"\"\"Raised when a scan buffer fills before matching an expected pattern.\"\"\"\n\ndef run (command, timeout=-1, withexitstatus=False, events=None, extra_args=None, logfile=None, cwd=None, env=None):\n\n \"\"\"\n This function runs the given command; waits for it to finish; then\n returns all output as a string. STDERR is included in output. If the full\n path to the command is not given then the path is searched.\n\n Note that lines are terminated by CR/LF (\\\\r\\\\n) combination even on\n UNIX-like systems because this is the standard for pseudo ttys. If you set\n 'withexitstatus' to true, then run will return a tuple of (command_output,\n exitstatus). If 'withexitstatus' is false then this returns just\n command_output.\n\n The run() function can often be used instead of creating a spawn instance.\n For example, the following code uses spawn::\n\n from pexpect import *\n child = spawn('scp foo myname@host.example.com:.')\n child.expect ('(?i)password')\n child.sendline (mypassword)\n\n The previous code can be replace with the following::\n\n from pexpect import *\n run ('scp foo myname@host.example.com:.', events={'(?i)password': mypassword})\n\n Examples\n ========\n\n Start the apache daemon on the local machine::\n\n from pexpect import *\n run (\"/usr/local/apache/bin/apachectl start\")\n\n Check in a file using SVN::\n\n from pexpect import *\n run (\"svn ci -m 'automatic commit' my_file.py\")\n\n Run a command and capture exit status::\n\n from pexpect import *\n (command_output, exitstatus) = run ('ls -l /bin', withexitstatus=1)\n\n Tricky Examples\n ===============\n\n The following will run SSH and execute 'ls -l' on the remote machine. The\n password 'secret' will be sent if the '(?i)password' pattern is ever seen::\n\n run (\"ssh username@machine.example.com 'ls -l'\", events={'(?i)password':'secret\\\\n'})\n\n This will start mencoder to rip a video from DVD. This will also display\n progress ticks every 5 seconds as it runs. For example::\n\n from pexpect import *\n def print_ticks(d):\n print d['event_count'],\n run (\"mencoder dvd://1 -o video.avi -oac copy -ovc copy\", events={TIMEOUT:print_ticks}, timeout=5)\n\n The 'events' argument should be a dictionary of patterns and responses.\n Whenever one of the patterns is seen in the command out run() will send the\n associated response string. Note that you should put newlines in your\n string if Enter is necessary. The responses may also contain callback\n functions. Any callback is function that takes a dictionary as an argument.\n The dictionary contains all the locals from the run() function, so you can\n access the child spawn object or any other variable defined in run()\n (event_count, child, and extra_args are the most useful). A callback may\n return True to stop the current run process otherwise run() continues until\n the next event. A callback may also return a string which will be sent to\n the child. 'extra_args' is not used by directly run(). It provides a way to\n pass data to a callback function through run() through the locals\n dictionary passed to a callback. \"\"\"\n\n if timeout == -1:\n child = spawn(command, maxread=2000, logfile=logfile, cwd=cwd, env=env)\n else:\n child = spawn(command, timeout=timeout, maxread=2000, logfile=logfile, cwd=cwd, env=env)\n if events is not None:\n patterns = events.keys()\n responses = events.values()\n else:\n patterns=None # We assume that EOF or TIMEOUT will save us.\n responses=None\n child_result_list = []\n event_count = 0\n while 1:\n try:\n index = child.expect (patterns)\n if type(child.after) in types.StringTypes:\n child_result_list.append(child.before + child.after)\n else: # child.after may have been a TIMEOUT or EOF, so don't cat those.\n child_result_list.append(child.before)\n if type(responses[index]) in types.StringTypes:\n child.send(responses[index])\n elif type(responses[index]) is types.FunctionType:\n callback_result = responses[index](locals())\n sys.stdout.flush()\n if type(callback_result) in types.StringTypes:\n child.send(callback_result)\n elif callback_result:\n break\n else:\n raise TypeError ('The callback must be a string or function type.')\n event_count = event_count + 1\n except TIMEOUT, e:\n child_result_list.append(child.before)\n break\n except EOF, e:\n child_result_list.append(child.before)\n break\n child_result = ''.join(child_result_list)\n if withexitstatus:\n child.close()\n return (child_result, child.exitstatus)\n else:\n return child_result\n\nclass spawn (object):\n\n \"\"\"This is the main class interface for Pexpect. Use this class to start\n and control child applications. \"\"\"\n\n def __init__(self, command, args=[], timeout=30, maxread=2000, searchwindowsize=None, logfile=None, cwd=None, env=None):\n\n \"\"\"This is the constructor. The command parameter may be a string that\n includes a command and any arguments to the command. For example::\n\n child = pexpect.spawn ('/usr/bin/ftp')\n child = pexpect.spawn ('/usr/bin/ssh user@example.com')\n child = pexpect.spawn ('ls -latr /tmp')\n\n You may also construct it with a list of arguments like so::\n\n child = pexpect.spawn ('/usr/bin/ftp', [])\n child = pexpect.spawn ('/usr/bin/ssh', ['user@example.com'])\n child = pexpect.spawn ('ls', ['-latr', '/tmp'])\n\n After this the child application will be created and will be ready to\n talk to. For normal use, see expect() and send() and sendline().\n\n Remember that Pexpect does NOT interpret shell meta characters such as\n redirect, pipe, or wild cards (>, |, or *). This is a common mistake.\n If you want to run a command and pipe it through another command then\n you must also start a shell. For example::\n\n child = pexpect.spawn('/bin/bash -c \"ls -l | grep LOG > log_list.txt\"')\n child.expect(pexpect.EOF)\n\n The second form of spawn (where you pass a list of arguments) is useful\n in situations where you wish to spawn a command and pass it its own\n argument list. This can make syntax more clear. For example, the\n following is equivalent to the previous example::\n\n shell_cmd = 'ls -l | grep LOG > log_list.txt'\n child = pexpect.spawn('/bin/bash', ['-c', shell_cmd])\n child.expect(pexpect.EOF)\n\n The maxread attribute sets the read buffer size. This is maximum number\n of bytes that Pexpect will try to read from a TTY at one time. Setting\n the maxread size to 1 will turn off buffering. Setting the maxread\n value higher may help performance in cases where large amounts of\n output are read back from the child. This feature is useful in\n conjunction with searchwindowsize.\n\n The searchwindowsize attribute sets the how far back in the incomming\n seach buffer Pexpect will search for pattern matches. Every time\n Pexpect reads some data from the child it will append the data to the\n incomming buffer. The default is to search from the beginning of the\n imcomming buffer each time new data is read from the child. But this is\n very inefficient if you are running a command that generates a large\n amount of data where you want to match The searchwindowsize does not\n effect the size of the incomming data buffer. You will still have\n access to the full buffer after expect() returns.\n\n The logfile member turns on or off logging. All input and output will\n be copied to the given file object. Set logfile to None to stop\n logging. This is the default. Set logfile to sys.stdout to echo\n everything to standard output. The logfile is flushed after each write.\n\n Example log input and output to a file::\n\n child = pexpect.spawn('some_command')\n fout = file('mylog.txt','w')\n child.logfile = fout\n\n Example log to stdout::\n\n child = pexpect.spawn('some_command')\n child.logfile = sys.stdout\n\n The logfile_read and logfile_send members can be used to separately log\n the input from the child and output sent to the child. Sometimes you\n don't want to see everything you write to the child. You only want to\n log what the child sends back. For example::\n\n child = pexpect.spawn('some_command')\n child.logfile_read = sys.stdout\n\n To separately log output sent to the child use logfile_send::\n\n self.logfile_send = fout\n\n The delaybeforesend helps overcome a weird behavior that many users\n were experiencing. The typical problem was that a user would expect() a\n \"Password:\" prompt and then immediately call sendline() to send the\n password. The user would then see that their password was echoed back\n to them. Passwords don't normally echo. The problem is caused by the\n fact that most applications print out the \"Password\" prompt and then\n turn off stdin echo, but if you send your password before the\n application turned off echo, then you get your password echoed.\n Normally this wouldn't be a problem when interacting with a human at a\n real keyboard. If you introduce a slight delay just before writing then\n this seems to clear up the problem. This was such a common problem for\n many users that I decided that the default pexpect behavior should be\n to sleep just before writing to the child application. 1/20th of a\n second (50 ms) seems to be enough to clear up the problem. You can set\n delaybeforesend to 0 to return to the old behavior. Most Linux machines\n don't like this to be below 0.03. I don't know why.\n\n Note that spawn is clever about finding commands on your path.\n It uses the same logic that \"which\" uses to find executables.\n\n If you wish to get the exit status of the child you must call the\n close() method. The exit or signal status of the child will be stored\n in self.exitstatus or self.signalstatus. If the child exited normally\n then exitstatus will store the exit return code and signalstatus will\n be None. If the child was terminated abnormally with a signal then\n signalstatus will store the signal value and exitstatus will be None.\n If you need more detail you can also read the self.status member which\n stores the status returned by os.waitpid. You can interpret this using\n os.WIFEXITED/os.WEXITSTATUS or os.WIFSIGNALED/os.TERMSIG. \"\"\"\n\n self.STDIN_FILENO = pty.STDIN_FILENO\n self.STDOUT_FILENO = pty.STDOUT_FILENO\n self.STDERR_FILENO = pty.STDERR_FILENO\n self.stdin = sys.stdin\n self.stdout = sys.stdout\n self.stderr = sys.stderr\n\n self.searcher = None\n self.ignorecase = False\n self.before = None\n self.after = None\n self.match = None\n self.match_index = None\n self.terminated = True\n self.exitstatus = None\n self.signalstatus = None\n self.status = None # status returned by os.waitpid\n self.flag_eof = False\n self.pid = None\n self.child_fd = -1 # initially closed\n self.timeout = timeout\n self.delimiter = EOF\n self.logfile = logfile\n self.logfile_read = None # input from child (read_nonblocking)\n self.logfile_send = None # output to send (send, sendline)\n self.maxread = maxread # max bytes to read at one time into buffer\n self.buffer = '' # This is the read buffer. See maxread.\n self.searchwindowsize = searchwindowsize # Anything before searchwindowsize point is preserved, but not searched.\n # Most Linux machines don't like delaybeforesend to be below 0.03 (30 ms).\n self.delaybeforesend = 0.05 # Sets sleep time used just before sending data to child. Time in seconds.\n self.delayafterclose = 0.1 # Sets delay in close() method to allow kernel time to update process status. Time in seconds.\n self.delayafterterminate = 0.1 # Sets delay in terminate() method to allow kernel time to update process status. Time in seconds.\n self.softspace = False # File-like object.\n self.name = '<' + repr(self) + '>' # File-like object.\n self.encoding = None # File-like object.\n self.closed = True # File-like object.\n self.cwd = cwd\n self.env = env\n self.__irix_hack = (sys.platform.lower().find('irix')>=0) # This flags if we are running on irix\n # Solaris uses internal __fork_pty(). All others use pty.fork().\n if (sys.platform.lower().find('solaris')>=0) or (sys.platform.lower().find('sunos5')>=0):\n self.use_native_pty_fork = False\n else:\n self.use_native_pty_fork = True\n\n\n # allow dummy instances for subclasses that may not use command or args.\n if command is None:\n self.command = None\n self.args = None\n self.name = '<pexpect factory incomplete>'\n else:\n self._spawn (command, args)\n\n def __del__(self):\n\n \"\"\"This makes sure that no system resources are left open. Python only\n garbage collects Python objects. OS file descriptors are not Python\n objects, so they must be handled explicitly. If the child file\n descriptor was opened outside of this class (passed to the constructor)\n then this does not close it. \"\"\"\n\n if not self.closed:\n # It is possible for __del__ methods to execute during the\n # teardown of the Python VM itself. Thus self.close() may\n # trigger an exception because os.close may be None.\n # -- Fernando Perez\n try:\n self.close()\n except:\n pass\n\n def __str__(self):\n\n \"\"\"This returns a human-readable string that represents the state of\n the object. \"\"\"\n\n s = []\n s.append(repr(self))\n s.append('version: ' + __version__ + ' (' + __revision__ + ')')\n s.append('command: ' + str(self.command))\n s.append('args: ' + str(self.args))\n s.append('searcher: ' + str(self.searcher))\n s.append('buffer (last 100 chars): ' + str(self.buffer)[-100:])\n s.append('before (last 100 chars): ' + str(self.before)[-100:])\n s.append('after: ' + str(self.after))\n s.append('match: ' + str(self.match))\n s.append('match_index: ' + str(self.match_index))\n s.append('exitstatus: ' + str(self.exitstatus))\n s.append('flag_eof: ' + str(self.flag_eof))\n s.append('pid: ' + str(self.pid))\n s.append('child_fd: ' + str(self.child_fd))\n s.append('closed: ' + str(self.closed))\n s.append('timeout: ' + str(self.timeout))\n s.append('delimiter: ' + str(self.delimiter))\n s.append('logfile: ' + str(self.logfile))\n s.append('logfile_read: ' + str(self.logfile_read))\n s.append('logfile_send: ' + str(self.logfile_send))\n s.append('maxread: ' + str(self.maxread))\n s.append('ignorecase: ' + str(self.ignorecase))\n s.append('searchwindowsize: ' + str(self.searchwindowsize))\n s.append('delaybeforesend: ' + str(self.delaybeforesend))\n s.append('delayafterclose: ' + str(self.delayafterclose))\n s.append('delayafterterminate: ' + str(self.delayafterterminate))\n return '\\n'.join(s)\n\n def _spawn(self,command,args=[]):\n\n \"\"\"This starts the given command in a child process. This does all the\n fork/exec type of stuff for a pty. This is called by __init__. If args\n is empty then command will be parsed (split on spaces) and args will be\n set to parsed arguments. \"\"\"\n\n # The pid and child_fd of this object get set by this method.\n # Note that it is difficult for this method to fail.\n # You cannot detect if the child process cannot start.\n # So the only way you can tell if the child process started\n # or not is to try to read from the file descriptor. If you get\n # EOF immediately then it means that the child is already dead.\n # That may not necessarily be bad because you may haved spawned a child\n # that performs some task; creates no stdout output; and then dies.\n\n # If command is an int type then it may represent a file descriptor.\n if type(command) == type(0):\n raise ExceptionPexpect ('Command is an int type. If this is a file descriptor then maybe you want to use fdpexpect.fdspawn which takes an existing file descriptor instead of a command string.')\n\n if type (args) != type([]):\n raise TypeError ('The argument, args, must be a list.')\n\n if args == []:\n self.args = split_command_line(command)\n self.command = self.args[0]\n else:\n self.args = args[:] # work with a copy\n self.args.insert (0, command)\n self.command = command\n\n command_with_path = which(self.command)\n if command_with_path is None:\n raise ExceptionPexpect ('The command was not found or was not executable: %s.' % self.command)\n self.command = command_with_path\n self.args[0] = self.command\n\n self.name = '<' + ' '.join (self.args) + '>'\n\n assert self.pid is None, 'The pid member should be None.'\n assert self.command is not None, 'The command member should not be None.'\n\n if self.use_native_pty_fork:\n try:\n self.pid, self.child_fd = pty.fork()\n except OSError, e:\n raise ExceptionPexpect('Error! pty.fork() failed: ' + str(e))\n else: # Use internal __fork_pty\n self.pid, self.child_fd = self.__fork_pty()\n\n if self.pid == 0: # Child\n try:\n self.child_fd = sys.stdout.fileno() # used by setwinsize()\n self.setwinsize(24, 80)\n except:\n # Some platforms do not like setwinsize (Cygwin).\n # This will cause problem when running applications that\n # are very picky about window size.\n # This is a serious limitation, but not a show stopper.\n pass\n # Do not allow child to inherit open file descriptors from parent.\n max_fd = resource.getrlimit(resource.RLIMIT_NOFILE)[0]\n for i in range (3, max_fd):\n try:\n os.close (i)\n except OSError:\n pass\n\n # I don't know why this works, but ignoring SIGHUP fixes a\n # problem when trying to start a Java daemon with sudo\n # (specifically, Tomcat).\n signal.signal(signal.SIGHUP, signal.SIG_IGN)\n\n if self.cwd is not None:\n os.chdir(self.cwd)\n if self.env is None:\n os.execv(self.command, self.args)\n else:\n os.execvpe(self.command, self.args, self.env)\n\n # Parent\n self.terminated = False\n self.closed = False\n\n def __fork_pty(self):\n\n \"\"\"This implements a substitute for the forkpty system call. This\n should be more portable than the pty.fork() function. Specifically,\n this should work on Solaris.\n\n Modified 10.06.05 by Geoff Marshall: Implemented __fork_pty() method to\n resolve the issue with Python's pty.fork() not supporting Solaris,\n particularly ssh. Based on patch to posixmodule.c authored by Noah\n Spurrier::\n\n http://mail.python.org/pipermail/python-dev/2003-May/035281.html\n\n \"\"\"\n\n parent_fd, child_fd = os.openpty()\n if parent_fd < 0 or child_fd < 0:\n raise ExceptionPexpect, \"Error! Could not open pty with os.openpty().\"\n\n pid = os.fork()\n if pid < 0:\n raise ExceptionPexpect, \"Error! Failed os.fork().\"\n elif pid == 0:\n # Child.\n os.close(parent_fd)\n self.__pty_make_controlling_tty(child_fd)\n\n os.dup2(child_fd, 0)\n os.dup2(child_fd, 1)\n os.dup2(child_fd, 2)\n\n if child_fd > 2:\n os.close(child_fd)\n else:\n # Parent.\n os.close(child_fd)\n\n return pid, parent_fd\n\n def __pty_make_controlling_tty(self, tty_fd):\n\n \"\"\"This makes the pseudo-terminal the controlling tty. This should be\n more portable than the pty.fork() function. Specifically, this should\n work on Solaris. \"\"\"\n\n child_name = os.ttyname(tty_fd)\n\n # Disconnect from controlling tty. Harmless if not already connected.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY);\n if fd >= 0:\n os.close(fd)\n except:\n # Already disconnected. This happens if running inside cron.\n pass\n\n os.setsid()\n\n # Verify we are disconnected from controlling tty\n # by attempting to open it again.\n try:\n fd = os.open(\"/dev/tty\", os.O_RDWR | os.O_NOCTTY);\n if fd >= 0:\n os.close(fd)\n raise ExceptionPexpect, \"Error! Failed to disconnect from controlling tty. It is still possible to open /dev/tty.\"\n except:\n # Good! We are disconnected from a controlling tty.\n pass\n\n # Verify we can open child pty.\n fd = os.open(child_name, os.O_RDWR);\n if fd < 0:\n raise ExceptionPexpect, \"Error! Could not open child pty, \" + child_name\n else:\n os.close(fd)\n\n # Verify we now have a controlling tty.\n fd = os.open(\"/dev/tty\", os.O_WRONLY)\n if fd < 0:\n raise ExceptionPexpect, \"Error! Could not open controlling tty, /dev/tty\"\n else:\n os.close(fd)\n\n def fileno (self): # File-like object.\n\n \"\"\"This returns the file descriptor of the pty for the child.\n \"\"\"\n\n return self.child_fd\n\n def close (self, force=True): # File-like object.\n\n \"\"\"This closes the connection with the child application. Note that\n calling close() more than once is valid. This emulates standard Python\n behavior with files. Set force to True if you want to make sure that\n the child is terminated (SIGKILL is sent if the child ignores SIGHUP\n and SIGINT). \"\"\"\n\n if not self.closed:\n self.flush()\n os.close (self.child_fd)\n time.sleep(self.delayafterclose) # Give kernel time to update process status.\n if self.isalive():\n if not self.terminate(force):\n raise ExceptionPexpect ('close() could not terminate the child using terminate()')\n self.child_fd = -1\n self.closed = True\n #self.pid = None\n\n def flush (self): # File-like object.\n\n \"\"\"This does nothing. It is here to support the interface for a\n File-like object. \"\"\"\n\n pass\n\n def isatty (self): # File-like object.\n\n \"\"\"This returns True if the file descriptor is open and connected to a\n tty(-like) device, else False. \"\"\"\n\n return os.isatty(self.child_fd)\n\n def waitnoecho (self, timeout=-1):\n\n \"\"\"This waits until the terminal ECHO flag is set False. This returns\n True if the echo mode is off. This returns False if the ECHO flag was\n not set False before the timeout. This can be used to detect when the\n child is waiting for a password. Usually a child application will turn\n off echo mode when it is waiting for the user to enter a password. For\n example, instead of expecting the \"password:\" prompt you can wait for\n the child to set ECHO off::\n\n p = pexpect.spawn ('ssh user@example.com')\n p.waitnoecho()\n p.sendline(mypassword)\n\n If timeout==-1 then this method will use the value in self.timeout.\n If timeout==None then this method to block until ECHO flag is False.\n \"\"\"\n\n if timeout == -1:\n timeout = self.timeout\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n if not self.getecho():\n return True\n if timeout < 0 and timeout is not None:\n return False\n if timeout is not None:\n timeout = end_time - time.time()\n time.sleep(0.1)\n\n def getecho (self):\n\n \"\"\"This returns the terminal echo mode. This returns True if echo is\n on or False if echo is off. Child applications that are expecting you\n to enter a password often set ECHO False. See waitnoecho(). \"\"\"\n\n attr = termios.tcgetattr(self.child_fd)\n if attr[3] & termios.ECHO:\n return True\n return False\n\n def setecho (self, state):\n\n \"\"\"This sets the terminal echo mode on or off. Note that anything the\n child sent before the echo will be lost, so you should be sure that\n your input buffer is empty before you call setecho(). For example, the\n following will work as expected::\n\n p = pexpect.spawn('cat')\n p.sendline ('1234') # We will see this twice (once from tty echo and again from cat).\n p.expect (['1234'])\n p.expect (['1234'])\n p.setecho(False) # Turn off tty echo\n p.sendline ('abcd') # We will set this only once (echoed by cat).\n p.sendline ('wxyz') # We will set this only once (echoed by cat)\n p.expect (['abcd'])\n p.expect (['wxyz'])\n\n The following WILL NOT WORK because the lines sent before the setecho\n will be lost::\n\n p = pexpect.spawn('cat')\n p.sendline ('1234') # We will see this twice (once from tty echo and again from cat).\n p.setecho(False) # Turn off tty echo\n p.sendline ('abcd') # We will set this only once (echoed by cat).\n p.sendline ('wxyz') # We will set this only once (echoed by cat)\n p.expect (['1234'])\n p.expect (['1234'])\n p.expect (['abcd'])\n p.expect (['wxyz'])\n \"\"\"\n\n self.child_fd\n attr = termios.tcgetattr(self.child_fd)\n if state:\n attr[3] = attr[3] | termios.ECHO\n else:\n attr[3] = attr[3] & ~termios.ECHO\n # I tried TCSADRAIN and TCSAFLUSH, but these were inconsistent\n # and blocked on some platforms. TCSADRAIN is probably ideal if it worked.\n termios.tcsetattr(self.child_fd, termios.TCSANOW, attr)\n\n def read_nonblocking (self, size = 1, timeout = -1):\n\n \"\"\"This reads at most size characters from the child application. It\n includes a timeout. If the read does not complete within the timeout\n period then a TIMEOUT exception is raised. If the end of file is read\n then an EOF exception will be raised. If a log file was set using\n setlog() then all data will also be written to the log file.\n\n If timeout is None then the read may block indefinitely. If timeout is -1\n then the self.timeout value is used. If timeout is 0 then the child is\n polled and if there was no data immediately ready then this will raise\n a TIMEOUT exception.\n\n The timeout refers only to the amount of time to read at least one\n character. This is not effected by the 'size' parameter, so if you call\n read_nonblocking(size=100, timeout=30) and only one character is\n available right away then one character will be returned immediately.\n It will not wait for 30 seconds for another 99 characters to come in.\n\n This is a wrapper around os.read(). It uses select.select() to\n implement the timeout. \"\"\"\n\n if self.closed:\n raise ValueError ('I/O operation on closed file in read_nonblocking().')\n\n if timeout == -1:\n timeout = self.timeout\n\n # Note that some systems such as Solaris do not give an EOF when\n # the child dies. In fact, you can still try to read\n # from the child_fd -- it will block forever or until TIMEOUT.\n # For this case, I test isalive() before doing any reading.\n # If isalive() is false, then I pretend that this is the same as EOF.\n if not self.isalive():\n r,w,e = self.__select([self.child_fd], [], [], 0) # timeout of 0 means \"poll\"\n if not r:\n self.flag_eof = True\n raise EOF ('End Of File (EOF) in read_nonblocking(). Braindead platform.')\n elif self.__irix_hack:\n # This is a hack for Irix. It seems that Irix requires a long delay before checking isalive.\n # This adds a 2 second delay, but only when the child is terminated.\n r, w, e = self.__select([self.child_fd], [], [], 2)\n if not r and not self.isalive():\n self.flag_eof = True\n raise EOF ('End Of File (EOF) in read_nonblocking(). Pokey platform.')\n\n r,w,e = self.__select([self.child_fd], [], [], timeout)\n\n if not r:\n if not self.isalive():\n # Some platforms, such as Irix, will claim that their processes are alive;\n # then timeout on the select; and then finally admit that they are not alive.\n self.flag_eof = True\n raise EOF ('End of File (EOF) in read_nonblocking(). Very pokey platform.')\n else:\n raise TIMEOUT ('Timeout exceeded in read_nonblocking().')\n\n if self.child_fd in r:\n try:\n s = os.read(self.child_fd, size)\n except OSError, e: # Linux does this\n self.flag_eof = True\n raise EOF ('End Of File (EOF) in read_nonblocking(). Exception style platform.')\n if s == '': # BSD style\n self.flag_eof = True\n raise EOF ('End Of File (EOF) in read_nonblocking(). Empty string style platform.')\n\n if self.logfile is not None:\n self.logfile.write (s)\n self.logfile.flush()\n if self.logfile_read is not None:\n self.logfile_read.write (s)\n self.logfile_read.flush()\n\n return s\n\n raise ExceptionPexpect ('Reached an unexpected state in read_nonblocking().')\n\n def read (self, size = -1): # File-like object.\n\n \"\"\"This reads at most \"size\" bytes from the file (less if the read hits\n EOF before obtaining size bytes). If the size argument is negative or\n omitted, read all data until EOF is reached. The bytes are returned as\n a string object. An empty string is returned when EOF is encountered\n immediately. \"\"\"\n\n if size == 0:\n return ''\n if size < 0:\n self.expect (self.delimiter) # delimiter default is EOF\n return self.before\n\n # I could have done this more directly by not using expect(), but\n # I deliberately decided to couple read() to expect() so that\n # I would catch any bugs early and ensure consistant behavior.\n # It's a little less efficient, but there is less for me to\n # worry about if I have to later modify read() or expect().\n # Note, it's OK if size==-1 in the regex. That just means it\n # will never match anything in which case we stop only on EOF.\n cre = re.compile('.{%d}' % size, re.DOTALL)\n index = self.expect ([cre, self.delimiter]) # delimiter default is EOF\n if index == 0:\n return self.after ### self.before should be ''. Should I assert this?\n return self.before\n\n def readline (self, size = -1): # File-like object.\n\n \"\"\"This reads and returns one entire line. A trailing newline is kept\n in the string, but may be absent when a file ends with an incomplete\n line. Note: This readline() looks for a \\\\r\\\\n pair even on UNIX\n because this is what the pseudo tty device returns. So contrary to what\n you may expect you will receive the newline as \\\\r\\\\n. An empty string\n is returned when EOF is hit immediately. Currently, the size argument is\n mostly ignored, so this behavior is not standard for a file-like\n object. If size is 0 then an empty string is returned. \"\"\"\n\n if size == 0:\n return ''\n index = self.expect (['\\r\\n', self.delimiter]) # delimiter default is EOF\n if index == 0:\n return self.before + '\\r\\n'\n else:\n return self.before\n\n def __iter__ (self): # File-like object.\n\n \"\"\"This is to support iterators over a file-like object.\n \"\"\"\n\n return self\n\n def next (self): # File-like object.\n\n \"\"\"This is to support iterators over a file-like object.\n \"\"\"\n\n result = self.readline()\n if result == \"\":\n raise StopIteration\n return result\n\n def readlines (self, sizehint = -1): # File-like object.\n\n \"\"\"This reads until EOF using readline() and returns a list containing\n the lines thus read. The optional \"sizehint\" argument is ignored. \"\"\"\n\n lines = []\n while True:\n line = self.readline()\n if not line:\n break\n lines.append(line)\n return lines\n\n def write(self, s): # File-like object.\n\n \"\"\"This is similar to send() except that there is no return value.\n \"\"\"\n\n self.send (s)\n\n def writelines (self, sequence): # File-like object.\n\n \"\"\"This calls write() for each element in the sequence. The sequence\n can be any iterable object producing strings, typically a list of\n strings. This does not add line separators There is no return value.\n \"\"\"\n\n for s in sequence:\n self.write (s)\n\n def send(self, s):\n\n \"\"\"This sends a string to the child process. This returns the number of\n bytes written. If a log file was set then the data is also written to\n the log. \"\"\"\n\n time.sleep(self.delaybeforesend)\n if self.logfile is not None:\n self.logfile.write (s)\n self.logfile.flush()\n if self.logfile_send is not None:\n self.logfile_send.write (s)\n self.logfile_send.flush()\n c = os.write (self.child_fd, s.encode(\"utf-8\"))\n return c\n\n def sendline(self, s=''):\n\n \"\"\"This is like send(), but it adds a line feed (os.linesep). This\n returns the number of bytes written. \"\"\"\n\n n = self.send (s)\n n = n + self.send (os.linesep)\n return n\n\n def sendcontrol(self, char):\n\n \"\"\"This sends a control character to the child such as Ctrl-C or\n Ctrl-D. For example, to send a Ctrl-G (ASCII 7)::\n\n child.sendcontrol('g')\n\n See also, sendintr() and sendeof().\n \"\"\"\n\n char = char.lower()\n a = ord(char)\n if a>=97 and a<=122:\n a = a - ord('a') + 1\n return self.send (chr(a))\n d = {'@':0, '`':0,\n '[':27, '{':27,\n '\\\\':28, '|':28,\n ']':29, '}': 29,\n '^':30, '~':30,\n '_':31,\n '?':127}\n if char not in d:\n return 0\n return self.send (chr(d[char]))\n\n def sendeof(self):\n\n \"\"\"This sends an EOF to the child. This sends a character which causes\n the pending parent output buffer to be sent to the waiting child\n program without waiting for end-of-line. If it is the first character\n of the line, the read() in the user program returns 0, which signifies\n end-of-file. This means to work as expected a sendeof() has to be\n called at the beginning of a line. This method does not send a newline.\n It is the responsibility of the caller to ensure the eof is sent at the\n beginning of a line. \"\"\"\n\n ### Hmmm... how do I send an EOF?\n ###C if ((m = write(pty, *buf, p - *buf)) < 0)\n ###C return (errno == EWOULDBLOCK) ? n : -1;\n #fd = sys.stdin.fileno()\n #old = termios.tcgetattr(fd) # remember current state\n #attr = termios.tcgetattr(fd)\n #attr[3] = attr[3] | termios.ICANON # ICANON must be set to recognize EOF\n #try: # use try/finally to ensure state gets restored\n # termios.tcsetattr(fd, termios.TCSADRAIN, attr)\n # if hasattr(termios, 'CEOF'):\n # os.write (self.child_fd, '%c' % termios.CEOF)\n # else:\n # # Silly platform does not define CEOF so assume CTRL-D\n # os.write (self.child_fd, '%c' % 4)\n #finally: # restore state\n # termios.tcsetattr(fd, termios.TCSADRAIN, old)\n if hasattr(termios, 'VEOF'):\n char = termios.tcgetattr(self.child_fd)[6][termios.VEOF]\n else:\n # platform does not define VEOF so assume CTRL-D\n char = chr(4)\n self.send(char)\n\n def sendintr(self):\n\n \"\"\"This sends a SIGINT to the child. It does not require\n the SIGINT to be the first character on a line. \"\"\"\n\n if hasattr(termios, 'VINTR'):\n char = termios.tcgetattr(self.child_fd)[6][termios.VINTR]\n else:\n # platform does not define VINTR so assume CTRL-C\n char = chr(3)\n self.send (char)\n\n def eof (self):\n\n \"\"\"This returns True if the EOF exception was ever raised.\n \"\"\"\n\n return self.flag_eof\n\n def terminate(self, force=False):\n\n \"\"\"This forces a child process to terminate. It starts nicely with\n SIGHUP and SIGINT. If \"force\" is True then moves onto SIGKILL. This\n returns True if the child was terminated. This returns False if the\n child could not be terminated. \"\"\"\n\n if not self.isalive():\n return True\n try:\n self.kill(signal.SIGHUP)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGCONT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n self.kill(signal.SIGINT)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n if force:\n self.kill(signal.SIGKILL)\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n return False\n except OSError, e:\n # I think there are kernel timing issues that sometimes cause\n # this to happen. I think isalive() reports True, but the\n # process is dead to the kernel.\n # Make one last attempt to see if the kernel is up to date.\n time.sleep(self.delayafterterminate)\n if not self.isalive():\n return True\n else:\n return False\n\n def wait(self):\n\n \"\"\"This waits until the child exits. This is a blocking call. This will\n not read any data from the child, so this will block forever if the\n child has unread output and has terminated. In other words, the child\n may have printed output then called exit(); but, technically, the child\n is still alive until its output is read. \"\"\"\n\n if self.isalive():\n pid, status = os.waitpid(self.pid, 0)\n else:\n raise ExceptionPexpect ('Cannot wait for dead child process.')\n self.exitstatus = os.WEXITSTATUS(status)\n if os.WIFEXITED (status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED (status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED (status):\n raise ExceptionPexpect ('Wait was called for a child process that is stopped. This is not supported. Is some other process attempting job control with our child pid?')\n return self.exitstatus\n\n def isalive(self):\n\n \"\"\"This tests if the child process is running or not. This is\n non-blocking. If the child was terminated then this will read the\n exitstatus or signalstatus of the child. This returns True if the child\n process appears to be running or False if not. It can take literally\n SECONDS for Solaris to return the right status. \"\"\"\n\n if self.terminated:\n return False\n\n if self.flag_eof:\n # This is for Linux, which requires the blocking form of waitpid to get\n # status of a defunct process. This is super-lame. The flag_eof would have\n # been set in read_nonblocking(), so this should be safe.\n waitpid_options = 0\n else:\n waitpid_options = os.WNOHANG\n\n try:\n pid, status = os.waitpid(self.pid, waitpid_options)\n except OSError, e: # No child processes\n if e[0] == errno.ECHILD:\n raise ExceptionPexpect ('isalive() encountered condition where \"terminated\" is 0, but there was no child process. Did someone else call waitpid() on our process?')\n else:\n raise e\n\n # I have to do this twice for Solaris. I can't even believe that I figured this out...\n # If waitpid() returns 0 it means that no child process wishes to\n # report, and the value of status is undefined.\n if pid == 0:\n try:\n pid, status = os.waitpid(self.pid, waitpid_options) ### os.WNOHANG) # Solaris!\n except OSError, e: # This should never happen...\n if e[0] == errno.ECHILD:\n raise ExceptionPexpect ('isalive() encountered condition that should never happen. There was no child process. Did someone else call waitpid() on our process?')\n else:\n raise e\n\n # If pid is still 0 after two calls to waitpid() then\n # the process really is alive. This seems to work on all platforms, except\n # for Irix which seems to require a blocking call on waitpid or select, so I let read_nonblocking\n # take care of this situation (unfortunately, this requires waiting through the timeout).\n if pid == 0:\n return True\n\n if pid == 0:\n return True\n\n if os.WIFEXITED (status):\n self.status = status\n self.exitstatus = os.WEXITSTATUS(status)\n self.signalstatus = None\n self.terminated = True\n elif os.WIFSIGNALED (status):\n self.status = status\n self.exitstatus = None\n self.signalstatus = os.WTERMSIG(status)\n self.terminated = True\n elif os.WIFSTOPPED (status):\n raise ExceptionPexpect ('isalive() encountered condition where child process is stopped. This is not supported. Is some other process attempting job control with our child pid?')\n return False\n\n def kill(self, sig):\n\n \"\"\"This sends the given signal to the child application. In keeping\n with UNIX tradition it has a misleading name. It does not necessarily\n kill the child unless you send the right signal. \"\"\"\n\n # Same as os.kill, but the pid is given for you.\n if self.isalive():\n os.kill(self.pid, sig)\n\n def compile_pattern_list(self, patterns):\n\n \"\"\"This compiles a pattern-string or a list of pattern-strings.\n Patterns must be a StringType, EOF, TIMEOUT, SRE_Pattern, or a list of\n those. Patterns may also be None which results in an empty list (you\n might do this if waiting for an EOF or TIMEOUT condition without\n expecting any pattern).\n\n This is used by expect() when calling expect_list(). Thus expect() is\n nothing more than::\n\n cpl = self.compile_pattern_list(pl)\n return self.expect_list(cpl, timeout)\n\n If you are using expect() within a loop it may be more\n efficient to compile the patterns first and then call expect_list().\n This avoid calls in a loop to compile_pattern_list()::\n\n cpl = self.compile_pattern_list(my_pattern)\n while some_condition:\n ...\n i = self.expect_list(clp, timeout)\n ...\n \"\"\"\n\n if patterns is None:\n return []\n if type(patterns) is not types.ListType:\n patterns = [patterns]\n\n compile_flags = re.DOTALL # Allow dot to match \\n\n if self.ignorecase:\n compile_flags = compile_flags | re.IGNORECASE\n compiled_pattern_list = []\n for p in patterns:\n if type(p) in types.StringTypes:\n compiled_pattern_list.append(re.compile(p, compile_flags))\n elif p is EOF:\n compiled_pattern_list.append(EOF)\n elif p is TIMEOUT:\n compiled_pattern_list.append(TIMEOUT)\n elif type(p) is type(re.compile('')):\n compiled_pattern_list.append(p)\n else:\n raise TypeError ('Argument must be one of StringTypes, EOF, TIMEOUT, SRE_Pattern, or a list of those type. %s' % str(type(p)))\n\n return compiled_pattern_list\n\n def expect(self, pattern, timeout = -1, searchwindowsize=-1):\n\n \"\"\"This seeks through the stream until a pattern is matched. The\n pattern is overloaded and may take several types. The pattern can be a\n StringType, EOF, a compiled re, or a list of any of those types.\n Strings will be compiled to re types. This returns the index into the\n pattern list. If the pattern was not a list this returns index 0 on a\n successful match. This may raise exceptions for EOF or TIMEOUT. To\n avoid the EOF or TIMEOUT exceptions add EOF or TIMEOUT to the pattern\n list. That will cause expect to match an EOF or TIMEOUT condition\n instead of raising an exception.\n\n If you pass a list of patterns and more than one matches, the first match\n in the stream is chosen. If more than one pattern matches at that point,\n the leftmost in the pattern list is chosen. For example::\n\n # the input is 'foobar'\n index = p.expect (['bar', 'foo', 'foobar'])\n # returns 1 ('foo') even though 'foobar' is a \"better\" match\n\n Please note, however, that buffering can affect this behavior, since\n input arrives in unpredictable chunks. For example::\n\n # the input is 'foobar'\n index = p.expect (['foobar', 'foo'])\n # returns 0 ('foobar') if all input is available at once,\n # but returs 1 ('foo') if parts of the final 'bar' arrive late\n\n After a match is found the instance attributes 'before', 'after' and\n 'match' will be set. You can see all the data read before the match in\n 'before'. You can see the data that was matched in 'after'. The\n re.MatchObject used in the re match will be in 'match'. If an error\n occurred then 'before' will be set to all the data read so far and\n 'after' and 'match' will be None.\n\n If timeout is -1 then timeout will be set to the self.timeout value.\n\n A list entry may be EOF or TIMEOUT instead of a string. This will\n catch these exceptions and return the index of the list entry instead\n of raising the exception. The attribute 'after' will be set to the\n exception type. The attribute 'match' will be None. This allows you to\n write code like this::\n\n index = p.expect (['good', 'bad', pexpect.EOF, pexpect.TIMEOUT])\n if index == 0:\n do_something()\n elif index == 1:\n do_something_else()\n elif index == 2:\n do_some_other_thing()\n elif index == 3:\n do_something_completely_different()\n\n instead of code like this::\n\n try:\n index = p.expect (['good', 'bad'])\n if index == 0:\n do_something()\n elif index == 1:\n do_something_else()\n except EOF:\n do_some_other_thing()\n except TIMEOUT:\n do_something_completely_different()\n\n These two forms are equivalent. It all depends on what you want. You\n can also just expect the EOF if you are waiting for all output of a\n child to finish. For example::\n\n p = pexpect.spawn('/bin/ls')\n p.expect (pexpect.EOF)\n print p.before\n\n If you are trying to optimize for speed then see expect_list().\n \"\"\"\n\n compiled_pattern_list = self.compile_pattern_list(pattern)\n return self.expect_list(compiled_pattern_list, timeout, searchwindowsize)\n\n def expect_list(self, pattern_list, timeout = -1, searchwindowsize = -1):\n\n \"\"\"This takes a list of compiled regular expressions and returns the\n index into the pattern_list that matched the child output. The list may\n also contain EOF or TIMEOUT (which are not compiled regular\n expressions). This method is similar to the expect() method except that\n expect_list() does not recompile the pattern list on every call. This\n may help if you are trying to optimize for speed, otherwise just use\n the expect() method. This is called by expect(). If timeout==-1 then\n the self.timeout value is used. If searchwindowsize==-1 then the\n self.searchwindowsize value is used. \"\"\"\n\n return self.expect_loop(searcher_re(pattern_list), timeout, searchwindowsize)\n\n def expect_exact(self, pattern_list, timeout = -1, searchwindowsize = -1):\n\n \"\"\"This is similar to expect(), but uses plain string matching instead\n of compiled regular expressions in 'pattern_list'. The 'pattern_list'\n may be a string; a list or other sequence of strings; or TIMEOUT and\n EOF.\n\n This call might be faster than expect() for two reasons: string\n searching is faster than RE matching and it is possible to limit the\n search to just the end of the input buffer.\n\n This method is also useful when you don't want to have to worry about\n escaping regular expression characters that you want to match.\"\"\"\n\n if type(pattern_list) in types.StringTypes or pattern_list in (TIMEOUT, EOF):\n pattern_list = [pattern_list]\n return self.expect_loop(searcher_string(pattern_list), timeout, searchwindowsize)\n\n def expect_loop(self, searcher, timeout = -1, searchwindowsize = -1):\n\n \"\"\"This is the common loop used inside expect. The 'searcher' should be\n an instance of searcher_re or searcher_string, which describes how and what\n to search for in the input.\n\n See expect() for other arguments, return value and exceptions. \"\"\"\n\n self.searcher = searcher\n\n if timeout == -1:\n timeout = self.timeout\n if timeout is not None:\n end_time = time.time() + timeout\n if searchwindowsize == -1:\n searchwindowsize = self.searchwindowsize\n\n try:\n incoming = self.buffer\n freshlen = len(incoming)\n while True: # Keep reading until exception or return.\n index = searcher.search(incoming, freshlen, searchwindowsize)\n if index >= 0:\n self.buffer = incoming[searcher.end : ]\n self.before = incoming[ : searcher.start]\n self.after = incoming[searcher.start : searcher.end]\n self.match = searcher.match\n self.match_index = index\n return self.match_index\n # No match at this point\n if timeout < 0 and timeout is not None:\n raise TIMEOUT ('Timeout exceeded in expect_any().')\n # Still have time left, so read more data\n c = self.read_nonblocking (self.maxread, timeout)\n freshlen = len(c)\n time.sleep (0.0001)\n incoming = incoming + c\n if timeout is not None:\n timeout = end_time - time.time()\n except EOF, e:\n self.buffer = ''\n self.before = incoming\n self.after = EOF\n index = searcher.eof_index\n if index >= 0:\n self.match = EOF\n self.match_index = index\n return self.match_index\n else:\n self.match = None\n self.match_index = None\n raise EOF (str(e) + '\\n' + str(self))\n except TIMEOUT, e:\n self.buffer = incoming\n self.before = incoming\n self.after = TIMEOUT\n index = searcher.timeout_index\n if index >= 0:\n self.match = TIMEOUT\n self.match_index = index\n return self.match_index\n else:\n self.match = None\n self.match_index = None\n raise TIMEOUT (str(e) + '\\n' + str(self))\n except:\n self.before = incoming\n self.after = None\n self.match = None\n self.match_index = None\n raise\n\n def getwinsize(self):\n\n \"\"\"This returns the terminal window size of the child tty. The return\n value is a tuple of (rows, cols). \"\"\"\n\n TIOCGWINSZ = getattr(termios, 'TIOCGWINSZ', 1074295912L)\n s = struct.pack('HHHH', 0, 0, 0, 0)\n x = fcntl.ioctl(self.fileno(), TIOCGWINSZ, s)\n return struct.unpack('HHHH', x)[0:2]\n\n def setwinsize(self, r, c):\n\n \"\"\"This sets the terminal window size of the child tty. This will cause\n a SIGWINCH signal to be sent to the child. This does not change the\n physical window size. It changes the size reported to TTY-aware\n applications like vi or curses -- applications that respond to the\n SIGWINCH signal. \"\"\"\n\n # Check for buggy platforms. Some Python versions on some platforms\n # (notably OSF1 Alpha and RedHat 7.1) truncate the value for\n # termios.TIOCSWINSZ. It is not clear why this happens.\n # These platforms don't seem to handle the signed int very well;\n # yet other platforms like OpenBSD have a large negative value for\n # TIOCSWINSZ and they don't have a truncate problem.\n # Newer versions of Linux have totally different values for TIOCSWINSZ.\n # Note that this fix is a hack.\n TIOCSWINSZ = getattr(termios, 'TIOCSWINSZ', -2146929561)\n if TIOCSWINSZ == 2148037735L: # L is not required in Python >= 2.2.\n TIOCSWINSZ = -2146929561 # Same bits, but with sign.\n # Note, assume ws_xpixel and ws_ypixel are zero.\n s = struct.pack('HHHH', r, c, 0, 0)\n fcntl.ioctl(self.fileno(), TIOCSWINSZ, s)\n\n def interact(self, escape_character = chr(29), input_filter = None, output_filter = None):\n\n \"\"\"This gives control of the child process to the interactive user (the\n human at the keyboard). Keystrokes are sent to the child process, and\n the stdout and stderr output of the child process is printed. This\n simply echos the child stdout and child stderr to the real stdout and\n it echos the real stdin to the child stdin. When the user types the\n escape_character this method will stop. The default for\n escape_character is ^]. This should not be confused with ASCII 27 --\n the ESC character. ASCII 29 was chosen for historical merit because\n this is the character used by 'telnet' as the escape character. The\n escape_character will not be sent to the child process.\n\n You may pass in optional input and output filter functions. These\n functions should take a string and return a string. The output_filter\n will be passed all the output from the child process. The input_filter\n will be passed all the keyboard input from the user. The input_filter\n is run BEFORE the check for the escape_character.\n\n Note that if you change the window size of the parent the SIGWINCH\n signal will not be passed through to the child. If you want the child\n window size to change when the parent's window size changes then do\n something like the following example::\n\n import pexpect, struct, fcntl, termios, signal, sys\n def sigwinch_passthrough (sig, data):\n s = struct.pack(\"HHHH\", 0, 0, 0, 0)\n a = struct.unpack('hhhh', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ , s))\n global p\n p.setwinsize(a[0],a[1])\n p = pexpect.spawn('/bin/bash') # Note this is global and used in sigwinch_passthrough.\n signal.signal(signal.SIGWINCH, sigwinch_passthrough)\n p.interact()\n \"\"\"\n\n # Flush the buffer.\n self.stdout.write (self.buffer)\n self.stdout.flush()\n self.buffer = ''\n mode = tty.tcgetattr(self.STDIN_FILENO)\n tty.setraw(self.STDIN_FILENO)\n try:\n self.__interact_copy(escape_character, input_filter, output_filter)\n finally:\n tty.tcsetattr(self.STDIN_FILENO, tty.TCSAFLUSH, mode)\n\n def __interact_writen(self, fd, data):\n\n \"\"\"This is used by the interact() method.\n \"\"\"\n\n while data != '' and self.isalive():\n n = os.write(fd, data)\n data = data[n:]\n\n def __interact_read(self, fd):\n\n \"\"\"This is used by the interact() method.\n \"\"\"\n\n return os.read(fd, 1000)\n\n def __interact_copy(self, escape_character = None, input_filter = None, output_filter = None):\n\n \"\"\"This is used by the interact() method.\n \"\"\"\n\n while self.isalive():\n r,w,e = self.__select([self.child_fd, self.STDIN_FILENO], [], [])\n if self.child_fd in r:\n data = self.__interact_read(self.child_fd)\n if output_filter: data = output_filter(data)\n if self.logfile is not None:\n self.logfile.write (data)\n self.logfile.flush()\n os.write(self.STDOUT_FILENO, data)\n if self.STDIN_FILENO in r:\n data = self.__interact_read(self.STDIN_FILENO)\n if input_filter: data = input_filter(data)\n i = data.rfind(escape_character)\n if i != -1:\n data = data[:i]\n self.__interact_writen(self.child_fd, data)\n break\n self.__interact_writen(self.child_fd, data)\n\n def __select (self, iwtd, owtd, ewtd, timeout=None):\n\n \"\"\"This is a wrapper around select.select() that ignores signals. If\n select.select raises a select.error exception and errno is an EINTR\n error then it is ignored. Mainly this is used to ignore sigwinch\n (terminal resize). \"\"\"\n\n # if select() is interrupted by a signal (errno==EINTR) then\n # we loop back and enter the select() again.\n if timeout is not None:\n end_time = time.time() + timeout\n while True:\n try:\n return select.select (iwtd, owtd, ewtd, timeout)\n except select.error, e:\n if e[0] == errno.EINTR:\n # if we loop back we have to subtract the amount of time we already waited.\n if timeout is not None:\n timeout = end_time - time.time()\n if timeout < 0:\n return ([],[],[])\n else: # something else caused the select.error, so this really is an exception\n raise\n\n##############################################################################\n# The following methods are no longer supported or allowed.\n\n def setmaxread (self, maxread):\n\n \"\"\"This method is no longer supported or allowed. I don't like getters\n and setters without a good reason. \"\"\"\n\n raise ExceptionPexpect ('This method is no longer supported or allowed. Just assign a value to the maxread member variable.')\n\n def setlog (self, fileobject):\n\n \"\"\"This method is no longer supported or allowed.\n \"\"\"\n\n raise ExceptionPexpect ('This method is no longer supported or allowed. Just assign a value to the logfile member variable.')\n\n##############################################################################\n# End of spawn class\n##############################################################################\n\nclass searcher_string (object):\n\n \"\"\"This is a plain string search helper for the spawn.expect_any() method.\n This helper class is for speed. For more powerful regex patterns\n see the helper class, searcher_re.\n\n Attributes:\n\n eof_index - index of EOF, or -1\n timeout_index - index of TIMEOUT, or -1\n\n After a successful match by the search() method the following attributes\n are available:\n\n start - index into the buffer, first byte of match\n end - index into the buffer, first byte after match\n match - the matching string itself\n\n \"\"\"\n\n def __init__(self, strings):\n\n \"\"\"This creates an instance of searcher_string. This argument 'strings'\n may be a list; a sequence of strings; or the EOF or TIMEOUT types. \"\"\"\n\n self.eof_index = -1\n self.timeout_index = -1\n self._strings = []\n for n, s in zip(range(len(strings)), strings):\n if s is EOF:\n self.eof_index = n\n continue\n if s is TIMEOUT:\n self.timeout_index = n\n continue\n self._strings.append((n, s))\n\n def __str__(self):\n\n \"\"\"This returns a human-readable string that represents the state of\n the object.\"\"\"\n\n ss = [ (ns[0],' %d: \"%s\"' % ns) for ns in self._strings ]\n ss.append((-1,'searcher_string:'))\n if self.eof_index >= 0:\n ss.append ((self.eof_index,' %d: EOF' % self.eof_index))\n if self.timeout_index >= 0:\n ss.append ((self.timeout_index,' %d: TIMEOUT' % self.timeout_index))\n ss.sort()\n ss = zip(*ss)[1]\n return '\\n'.join(ss)\n\n def search(self, buffer, freshlen, searchwindowsize=None):\n\n \"\"\"This searches 'buffer' for the first occurence of one of the search\n strings. 'freshlen' must indicate the number of bytes at the end of\n 'buffer' which have not been searched before. It helps to avoid\n searching the same, possibly big, buffer over and over again.\n\n See class spawn for the 'searchwindowsize' argument.\n\n If there is a match this returns the index of that string, and sets\n 'start', 'end' and 'match'. Otherwise, this returns -1. \"\"\"\n\n absurd_match = len(buffer)\n first_match = absurd_match\n\n # 'freshlen' helps a lot here. Further optimizations could\n # possibly include:\n #\n # using something like the Boyer-Moore Fast String Searching\n # Algorithm; pre-compiling the search through a list of\n # strings into something that can scan the input once to\n # search for all N strings; realize that if we search for\n # ['bar', 'baz'] and the input is '...foo' we need not bother\n # rescanning until we've read three more bytes.\n #\n # Sadly, I don't know enough about this interesting topic. /grahn\n\n for index, s in self._strings:\n if searchwindowsize is None:\n # the match, if any, can only be in the fresh data,\n # or at the very end of the old data\n offset = -(freshlen+len(s))\n else:\n # better obey searchwindowsize\n offset = -searchwindowsize\n n = buffer.find(s, offset)\n if n >= 0 and n < first_match:\n first_match = n\n best_index, best_match = index, s\n if first_match == absurd_match:\n return -1\n self.match = best_match\n self.start = first_match\n self.end = self.start + len(self.match)\n return best_index\n\nclass searcher_re (object):\n\n \"\"\"This is regular expression string search helper for the\n spawn.expect_any() method. This helper class is for powerful\n pattern matching. For speed, see the helper class, searcher_string.\n\n Attributes:\n\n eof_index - index of EOF, or -1\n timeout_index - index of TIMEOUT, or -1\n\n After a successful match by the search() method the following attributes\n are available:\n\n start - index into the buffer, first byte of match\n end - index into the buffer, first byte after match\n match - the re.match object returned by a succesful re.search\n\n \"\"\"\n\n def __init__(self, patterns):\n\n \"\"\"This creates an instance that searches for 'patterns' Where\n 'patterns' may be a list or other sequence of compiled regular\n expressions, or the EOF or TIMEOUT types.\"\"\"\n\n self.eof_index = -1\n self.timeout_index = -1\n self._searches = []\n for n, s in zip(range(len(patterns)), patterns):\n if s is EOF:\n self.eof_index = n\n continue\n if s is TIMEOUT:\n self.timeout_index = n\n continue\n self._searches.append((n, s))\n\n def __str__(self):\n\n \"\"\"This returns a human-readable string that represents the state of\n the object.\"\"\"\n\n ss = [ (n,' %d: re.compile(\"%s\")' % (n,str(s.pattern))) for n,s in self._searches]\n ss.append((-1,'searcher_re:'))\n if self.eof_index >= 0:\n ss.append ((self.eof_index,' %d: EOF' % self.eof_index))\n if self.timeout_index >= 0:\n ss.append ((self.timeout_index,' %d: TIMEOUT' % self.timeout_index))\n ss.sort()\n ss = zip(*ss)[1]\n return '\\n'.join(ss)\n\n def search(self, buffer, freshlen, searchwindowsize=None):\n\n \"\"\"This searches 'buffer' for the first occurence of one of the regular\n expressions. 'freshlen' must indicate the number of bytes at the end of\n 'buffer' which have not been searched before.\n\n See class spawn for the 'searchwindowsize' argument.\n\n If there is a match this returns the index of that string, and sets\n 'start', 'end' and 'match'. Otherwise, returns -1.\"\"\"\n\n absurd_match = len(buffer)\n first_match = absurd_match\n # 'freshlen' doesn't help here -- we cannot predict the\n # length of a match, and the re module provides no help.\n if searchwindowsize is None:\n searchstart = 0\n else:\n searchstart = max(0, len(buffer)-searchwindowsize)\n for index, s in self._searches:\n match = s.search(buffer, searchstart)\n if match is None:\n continue\n n = match.start()\n if n < first_match:\n first_match = n\n the_match = match\n best_index = index\n if first_match == absurd_match:\n return -1\n self.start = first_match\n self.match = the_match\n self.end = self.match.end()\n return best_index\n\ndef which (filename):\n\n \"\"\"This takes a given filename; tries to find it in the environment path;\n then checks if it is executable. This returns the full path to the filename\n if found and executable. Otherwise this returns None.\"\"\"\n\n # Special case where filename already contains a path.\n if os.path.dirname(filename) != '':\n if os.access (filename, os.X_OK):\n return filename\n\n if not os.environ.has_key('PATH') or os.environ['PATH'] == '':\n p = os.defpath\n else:\n p = os.environ['PATH']\n\n # Oddly enough this was the one line that made Pexpect\n # incompatible with Python 1.5.2.\n #pathlist = p.split (os.pathsep)\n pathlist = string.split (p, os.pathsep)\n\n for path in pathlist:\n f = os.path.join(path, filename)\n if os.access(f, os.X_OK):\n return f\n return None\n\ndef split_command_line(command_line):\n\n \"\"\"This splits a command line into a list of arguments. It splits arguments\n on spaces, but handles embedded quotes, doublequotes, and escaped\n characters. It's impossible to do this with a regular expression, so I\n wrote a little state machine to parse the command line. \"\"\"\n\n arg_list = []\n arg = ''\n\n # Constants to name the states we can be in.\n state_basic = 0\n state_esc = 1\n state_singlequote = 2\n state_doublequote = 3\n state_whitespace = 4 # The state of consuming whitespace between commands.\n state = state_basic\n\n for c in command_line:\n if state == state_basic or state == state_whitespace:\n if c == '\\\\': # Escape the next character\n state = state_esc\n elif c == r\"'\": # Handle single quote\n state = state_singlequote\n elif c == r'\"': # Handle double quote\n state = state_doublequote\n elif c.isspace():\n # Add arg to arg_list if we aren't in the middle of whitespace.\n if state == state_whitespace:\n None # Do nothing.\n else:\n arg_list.append(arg)\n arg = ''\n state = state_whitespace\n else:\n arg = arg + c\n state = state_basic\n elif state == state_esc:\n arg = arg + c\n state = state_basic\n elif state == state_singlequote:\n if c == r\"'\":\n state = state_basic\n else:\n arg = arg + c\n elif state == state_doublequote:\n if c == r'\"':\n state = state_basic\n else:\n arg = arg + c\n\n if arg != '':\n arg_list.append(arg)\n return arg_list\n\n# vi:set sr et ts=4 sw=4 ft=python :\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227996,"cells":{"text":{"kind":"string","value":"# -*- coding: utf-8 -*-\n\nversion = \"0.1.8\"\n\n# This file is part of EventGhost.\n# Copyright (C) 2008-2013 Pako <lubos.ruckl@quick.cz>\n#\n# EventGhost is free software; you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation; either version 2 of the License, or\n# (at your option) any later version.\n#\n# EventGhost is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with EventGhost; if not, write to the Free Software\n# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA\n#\n#\n# Changelog (in reverse chronological order):\n# -------------------------------------------\n# 0.1.8 by Pako 2013-03-25 08:42 UTC+1\n# - added wx.ComboBox for event suffix (action \"Start observation\")\n#===============================================================================\n#Structure of setup/account (one record):\n#-----------------------------------------\n# labelCtrl 0\n# choiceType 1\n# userNameCtrl 2\n# mailAddressCtrl 3\n# replAddressCtrl 4\n# incServerCtrl 5\n# incPortCtrl 6\n# userLoginCtrl 7\n# outServerCtrl 8\n# choiceSecureCtrl 9\n# useSecureCtrl 10\n# userPasswordCtrl 11\n\n#SMTP servers structure (one record):\n#-------------------------------------\n#[0] = servName\n#[1] = servAddress\n#[2] = port\n#[3] = secConnect\n#[4] = secAutent\n#[5] = userName\n#[6] = userPassw\n\n#texts structure (one record): [txtName, txt]\n\n#groups structure (one record): [groupName, [list of addresses]]\n\n#tempData structure (one record):\n#--------------------------------\n#[0] observName\n#[1] last count\n#[2] array of messages: [id, subject, from, account,numAbs,numAccount], [], ...\n#[3] Work thread\n#[4] Notification Frame\n#Empty record:['', 0, [], None, None]\n\n# Configs (Start observation) structure (one record):\n#----------------------------------------------------\n#[0]=observName = string\n#[1]=interval - integer\n#[2]=[accounts] - list\n#[3]=event name - string\n#[4]=mode - integer (0-2)\n#[5]=filter[[integer,integer,string],[],[],[],[],[],...]\n#[6]=show notif window - boolean\n#[7]=trigger event - boolean\n#[8]=attach payload - integer (0, 1)\n#[9]=Background Colour\n#[10]=Foreground Colour\n#[11]=trigger event2 - boolean\n#[12]=event name2 - string\n#[13]=attach payload2 - integer (0, 1, 2, 3)\n#[14]=delete event - boolean\n#===============================================================================\n\neg.RegisterPlugin(\n name = \"E-mail\",\n author = \"Pako\",\n version = version,\n kind = \"other\",\n guid = \"{8BEB93CE-242E-46B5-A17A-D9737D362E1E}\",\n createMacrosOnAdd = True,\n icon = (\n \"iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAADAFBMVEX////KysqhoaGA\"\n \"gIA+Pj4AAABVVVWfn5+2traPj48pKSkVFRUQEBALCwsGBgYNDQ0kJCRxcXG7u7ucnJwf\"\n \"Hx8aGhpkZGTS0tLc3NxhYWEXFxeDg4OkpKTAwMCwsLCZmZkiIiIICAgsLCyXl5fX19dX\"\n \"V1cDAwMzMzN9fX3CwsJmZmaSkpJDQ0O9vb1cXFw7OzvMzMzHx8eFhYWzs7NpaWkSEhKU\"\n \"lJQdHR1KSkpsbGxQUFBAQEDZ2dlNTU1fX194eHhubm57e3snJyempqZaWlpzc3NSUlKp\"\n \"qak2Njbe3t4xMTHFxcWurq7Pz8+NjY2rq6u4uLgAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\"\n \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\"\n \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\"\n \"AAAAAAAAAAAAQADJwHjJwHgAAQQAAADJxqDJxqAAAFgAAAAAAAAAAAAAAAAAAAAAAADJ\"\n \"zKjJzEAAADQAAADJ/QzJ/QwAACQAAAAAAAAAAAAAAAAAAAAAAGgAABNBmXQAAAAAAADJ\"\n \"xwjJxwgAAIwAAAAAAAAAAAAAAAAAEAAAAADJydDJxpAAAGgAAADJxzzJxzwAAFgAAAAA\"\n \"AAAAAAAAAAAAAIAAAADJx8jJx8gAADQAAADJv/zJv/wAACQAAAAAAAAAACAAAAAAAAAA\"\n \"BeQAABNBmXQAAAAAAABhZgRhZgQAJvgAAAAAAAAAAAAAAAAAAAAIAABhZgRhZgQAJtQA\"\n \"AADJv/zJv/wAACQAAAAAAAAAAAAIAAAAAAAAADQAABNBmXQAAAAAAABhZgRhZgQAJpAA\"\n \"AAAAAAAAAAAAAAAAAAABAABhZgRhZgQAJmwAAADJyEDJyEAAAFgAAAAAAgAAAAAAAAAA\"\n \"AAAAAADJxfTJxYwAADQAAADJ/QzJ/QwAACQAAAAAAAAAAAAAAAAAAAAAAGjfdT5zAAAA\"\n \"AXRSTlMAQObYZgAAAAlwSFlzAAALEgAACxIB0t1+/AAAAf9JREFUeNqFU+ta2kAQXZRJ\"\n \"Yi4bIgQsNF2WyGIBK9bGFIsiarUqvbz/0/RsEiGg/Tp/dmfmfHPOzM4ytrbKzm6ViAzT\"\n \"Ym/Znu04rsc59x2nFuxvp+sNl0rmhc1WOX3wro2o3XlvRVH0QQRdItmL1/nDviIaHH1c\"\n \"BaxhSNQevbgtA/nxJutxTVIoCucTkTrJKSdCnLJKLOqm8Ii6kyz42VHUq+jbWXACKjHQ\"\n \"MtkXn/N+BmgQJef60nGKHqSUHmMDUqnmHaGBrzo/5SSTEOaRIg5mzMRAPCVydIEdCLcz\"\n \"pRfkacDkGzIzFqHA5QHC6D3NZQc5gF0RuWdsBOImvCgBkG0AhgDU2RwjDuDFbg4sAebE\"\n \"Vcq6nNMcnq0kXW8CjkiiXTRFC3h4oKxSCbBASv4PQCuK2msKaOA3bFGI3MXsh5uAgMjf\"\n \"Y6MkT9wCeJcDvpfaNJmFOdzDm2Gi1fz1rgvAPQARm2HCtQeNl4p+POqJ3EAcANYTRq0L\"\n \"+qQu9E43SCoHb5UvZztMOPla3bMucYzLslG8tl2VntSby9NsC6eu4uNszTooSpfxfv9l\"\n \"uY1M08xG7fz6LIQ4xBHHQptZrH4cQtXVT/ZvOw+xQ+PlOvC4jTZtjsW8+/Ub/yZa1uOm\"\n \"sV2j1Wx75a/nvKb5M2242d/l0nfc3ptSLNOAFnqa1x9OV8G/O1M0GpLUB68AAAAASUVO\"\n \"RK5CYII=\"\n ),\n description = (\n \"Adds E-mail actions.\"\n ),\n url = \"http://www.eventghost.net/forum/viewtopic.php?f=9&t=1168\",\n)\nfrom wx.lib.intctrl import IntCtrl as intCtrl\nfrom threading import Thread, Event\nfrom threading import enumerate as threnum\nimport time\nimport re\nfrom copy import deepcopy as cpy\nfrom eg.WinApi.Dynamic import BringWindowToTop, CreateEvent, SetEvent\nimport _winreg, os, win32api\nimport poplib, imaplib, smtplib\nfrom email.header import decode_header\nfrom email.Header import Header\nfrom email.MIMEText import MIMEText\nfrom email.Utils import parseaddr, formataddr,formatdate\nimport email.Parser as parser\nmyParser = parser.Parser()\n#===============================================================================\n\ndef SendCfg(\n self,\n panel,\n sbjct,\n From,\n To,\n Copy,\n Txt,\n Append,\n toName,\n text,\n plugin\n ):\n self.plugin = plugin\n subjectLbl=wx.StaticText(panel, -1, text.subjectLabel)\n subjectCtrl=wx.TextCtrl(panel,-1,sbjct)\n fromLbl=wx.StaticText(panel, -1, text.fromLabel)\n choices = [\"%s <%s> - %s\" % (item[2],item[3],item[0]) for item in self.plugin.configs]\n fromCtrl=wx.Choice(panel,-1,choices = choices)\n fromCtrl.SetStringSelection(From)\n toLbl=wx.StaticText(panel, -1, text.toLabel)\n toNameCtrl=wx.TextCtrl(panel,-1,toName)\n toCtrl=wx.TextCtrl(panel,-1,To)\n copyLbl=wx.StaticText(panel, -1, text.copyLabel)\n choices = ['']\n choices.extend([item[0] for item in self.plugin.groups])\n copyCtrl=wx.Choice(panel,-1,choices = choices)\n copyCtrl.SetStringSelection(Copy)\n textLbl=wx.StaticText(panel, -1, text.outText)\n outTextCtrl=wx.TextCtrl(\n panel,-1,'',size=(-1, 60),\n style=wx.TE_MULTILINE|wx.TE_PROCESS_ENTER|wx.HSCROLL|wx.TE_AUTO_URL|wx.TE_RICH2\n )\n outTextCtrl.SetValue(Txt)\n textsLbl=wx.StaticText(panel, -1, text.outTexts)\n choices = ['']\n choices.extend([item[0] for item in self.plugin.texts])\n textsCtrl=wx.ComboBox(panel, -1, choices = choices, size = (200,-1))\n textsCtrl.SetValue(Append)\n toNameCtrl.SetToolTipString(text.tip1+'.\\n'+text.tip)\n toCtrl.SetToolTipString(text.tip2+'.\\n'+text.tip)\n outTextCtrl.SetToolTipString(text.tip)\n subjectCtrl.SetToolTipString(text.tip)\n textsCtrl.SetToolTipString(text.tip)\n\n topSizer = wx.GridBagSizer(5, 5)\n topSizer.Add(subjectLbl,(0, 0),flag = wx.ALIGN_RIGHT)\n topSizer.Add(subjectCtrl, (0, 1), (1, 2), flag = wx.EXPAND)\n topSizer.Add(fromLbl,(1, 0),flag = wx.ALIGN_RIGHT)\n topSizer.Add(fromCtrl, (1, 1), (1, 2), flag = wx.EXPAND)\n topSizer.Add(toLbl,(2, 0),flag = wx.ALIGN_RIGHT)\n topSizer.Add(toNameCtrl, (2, 1), flag = wx.EXPAND)\n topSizer.Add(toCtrl, (2, 2), flag = wx.EXPAND)\n topSizer.Add(copyLbl,(3, 0),flag = wx.ALIGN_RIGHT)\n topSizer.Add(copyCtrl, (3, 1), (1, 2), flag = wx.EXPAND)\n topSizer.Add(textLbl,(4, 0), flag = wx.ALIGN_RIGHT)\n topSizer.Add(outTextCtrl, (4, 1), (1, 2), flag = wx.EXPAND)\n topSizer.Add(textsLbl,(5, 0),flag = wx.ALIGN_RIGHT)\n topSizer.Add(textsCtrl, (5, 1), (1, 2), flag = wx.EXPAND)\n topSizer.AddGrowableCol(1)\n topSizer.AddGrowableCol(2)\n topSizer.AddGrowableRow(4)\n\n return (subjectCtrl,\n fromCtrl,\n toCtrl,\n copyCtrl,\n outTextCtrl,\n textsCtrl,\n toNameCtrl,\n topSizer\n )\n\n#===============================================================================\n\ndef validateEmailAddr(emailAddr):\n if len(emailAddr) > 5:\n if re.match(\n r\"^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\\]?)$\",\n emailAddr\n ) != None:\n return True\n return False\n\n\ndef DecodeSection(section, coding=None):\n if coding:\n List = (coding, 'utf-8', 'iso-8859-1', 'us-ascii')\n else:\n List = ('utf-8', 'iso-8859-1', 'us-ascii')\n for charset in List:\n try:\n section = section.decode(charset,'strict')\n# except UnicodeError:\n except:\n pass\n else:\n return section.strip(' \"')\n\n for charset in List:\n try:\n section = section.decode(charset,'replace')\n# except UnicodeError:\n except:\n pass\n else:\n return section.strip(' \"')\n return u''\n\n\ndef ParseItem(item):\n x = decode_header(item)[0]\n if x[1]:\n return DecodeSection(x[0],x[1])\n else:\n return x[0]\n\n\ndef ParseAddress(item):\n parseAddr = parseaddr(item)\n if parseAddr[0] == '':\n return parseAddr[1]\n decAddr = decode_header(parseAddr[0])[0]\n if not decAddr[1]:\n return parseAddr[0]\n else:\n return DecodeSection(decAddr[0], decAddr[1])\n#===============================================================================\n\ndef GetParts(msg, ext = False):\n from email.Iterators import typed_subpart_iterator\n partCounter=0\n bodyText=[]\n def get_charset(part, default=\"ascii\"):\n \"\"\"Get the part charset\"\"\"\n if part.get_content_charset():\n return part.get_content_charset()\n if part.get_charset():\n return part.get_charset()\n return default\n\n def get_body(message):\n \"\"\"Get the body of the email message\"\"\"\n#ToDo : option choice for html part viewing\n if message.is_multipart():\n #get the text (plain or html) version only\n text_parts = [part\n# for part in typed_subpart_iterator(message,\n# 'text',\n# 'plain')]\n for part in typed_subpart_iterator(message, 'text')]\n body = []\n for part in text_parts:\n charset = get_charset(part, get_charset(message))\n try:\n body.append(unicode(part.get_payload(decode=True),\n charset,\n \"replace\"))\n except:\n body.append(unicode(part.get_payload(decode=True),\n 'us-ascii',\n \"replace\"))\n return u\"\\n\".join(body).strip()+u\"\\n\"\n\n else: # if it is not multipart, the payload will be a string\n # representing the message body\n try:\n body = unicode(message.get_payload(decode=True),\n get_charset(message),\n \"replace\")\n except:\n body = unicode(message.get_payload(decode=True),\n 'us-ascii',\n \"replace\")\n return body.strip()+u\"\\n\"\n\n if not ext:\n return [ParseItem(msg['Subject']),msg['From'], get_body(msg)]\n else:\n return [\n ParseItem(msg['Subject']),\n msg['From'],\n get_body(msg),\n None,\n None,\n msg['References'],\n msg['Reply-To'],\n msg['Message-ID'],\n msg['X-Original-To'] if msg.has_key('X-Original-To') else parseaddr(msg['To'])[1],\n ]\n#===============================================================================\n\ndef RunEmailClient(text):\n \"\"\"Get the path of default email client through querying the\n Windows registry. \"\"\"\n try:\n em_reg = _winreg.OpenKey(\n _winreg.HKEY_CLASSES_ROOT,\n \"\\\\mailto\\\\shell\\\\open\\\\command\"\n )\n EmPath = _winreg.EnumValue(em_reg,0)[1]\n _winreg.CloseKey(em_reg)\n EmPath = EmPath.split('\"')[1]\n except:\n eg.PrintError(text.error9)\n else:\n head, tail = os.path.split(EmPath)\n win32api.ShellExecute(\n 0,\n None,\n tail,\n None,\n head,\n 1\n )\n#===============================================================================\n\ndef Move(lst,index,direction):\n tmpList = lst[:]\n max = len(lst)-1\n #Last to first position, other down\n if index == max and direction == 1:\n tmpList[1:] = lst[:-1]\n tmpList[0] = lst[max]\n index2 = 0\n #First to last position, other up\n elif index == 0 and direction == -1:\n tmpList[:-1] = lst[1:]\n tmpList[max] = lst[0]\n index2 = max\n else:\n index2 = index+direction\n tmpList[index] = lst[index2]\n tmpList[index2] = lst[index]\n return index2,tmpList\n#===============================================================================\n\nclass MessageFrame(wx.MiniFrame):\n def __init__(self, parent, message):\n self.message = message\n self.setup = parent.setup\n wx.MiniFrame.__init__(\n self,\n None,\n -1,\n '',\n size=(-1, -1),\n style=wx.CAPTION|wx.RESIZE_BORDER\n )\n self.parent = parent\n self.plugin = parent.plugin\n self.SetBackgroundColour(wx.NullColour)\n self.id = self.plugin.tempData[self.message[3]][2][int(self.message[4][0])-1][0]\n\n def ShowMessageFrame(\n self, position, size\n ):\n\n text = self.plugin.text\n self.setTitle()\n mainSizer = wx.BoxSizer(wx.VERTICAL)\n centralSizer = wx.GridBagSizer(10, 10)\n centralSizer.AddGrowableRow(0)\n centralSizer.AddGrowableCol(1)\n centralSizer.AddGrowableCol(3)\n centralSizer.AddGrowableCol(5)\n self.messageCtrl = wx.TextCtrl(\n self,\n -1,\n '', #wx.TE_AUTO_URL not works\n style=wx.TE_MULTILINE|wx.TE_READONLY|wx.HSCROLL|wx.TE_AUTO_URL|wx.TE_RICH2\n )\n self.messageCtrl.SetValue(self.message[2]) #wx.TE_AUTO_URL activation\n #Buttons\n sizes = []\n sizes.append(self.GetTextExtent(text.delete)[0])\n sizes.append(self.GetTextExtent(text.client)[0])\n sizes.append(self.GetTextExtent(text.reply)[0])\n sizes.append(self.GetTextExtent(text.close)[0])\n w=max(sizes)+12\n self.deleteButton = wx.Button(self, -1, text.delete, size=((w,-1)))\n self.clientButton = wx.Button(self, -1, text.client, size=((w,-1)))\n self.replyButton = wx.Button(self, -1, text.reply, size=((w,-1)))\n self.closeButton = wx.Button(self, -1, text.close, size=((w,-1)))\n centralSizer.Add(self.messageCtrl, (0,0),(1,7), flag = wx.EXPAND)\n centralSizer.Add(self.deleteButton,(1,0), flag = wx.ALIGN_LEFT|wx.BOTTOM,border = 10)\n centralSizer.Add(self.clientButton,(1,2), flag = wx.ALIGN_CENTER_HORIZONTAL)\n centralSizer.Add(self.replyButton,(1,4), flag = wx.ALIGN_CENTER_HORIZONTAL)\n centralSizer.Add(self.closeButton,(1,6), flag = wx.RIGHT)\n mainSizer.Add(centralSizer, 1,wx.EXPAND|wx.LEFT|wx.RIGHT|wx.TOP,10)\n self.SetSizer(mainSizer)\n mainSizer.Fit(self)\n mainSizer.Layout()\n\n def onURLclick(event):\n if event.MouseEvent.LeftDown():\n url = event.GetEventObject().GetValue()[event.GetURLStart(): event.GetURLEnd()]\n wx.LaunchDefaultBrowser(url)\n else:\n event.Skip()\n self.messageCtrl.Bind(wx.EVT_TEXT_URL,onURLclick)\n\n def OnCloseWindow(event):\n self.parent.messFramSize = self.GetSize()\n self.parent.messFramPosition = self.GetPosition()\n self.Destroy()\n event.Skip()\n self.Bind(wx.EVT_CLOSE, OnCloseWindow)\n\n def onCloseButton(evt):\n self.Close(True)\n self.closeButton.Bind(wx.EVT_BUTTON, onCloseButton)\n\n def onClientButton(evt):\n RunEmailClient(text)\n self.clientButton.Bind(wx.EVT_BUTTON, onClientButton)\n\n def onReplyButton(evt):\n addressList = [item[3] for item in self.plugin.configs]\n if self.message[8] in addressList:\n indx = addressList.index(self.message[8])\n else:\n indx = 0\n From = [\"%s <%s> - %s\" % (item[2],item[3],item[0]) for item in self.plugin.configs][indx]\n sbjct = u\"Re: \"+self.message[0]\n replAddr = parseaddr(self.message[6])\n fromAddr = parseaddr(self.message[1])\n if replAddr[1] != '':\n To = replAddr[1]\n else:\n To = fromAddr[1]\n if replAddr[0] != '':\n toName = ParseAddress(self.message[6])\n elif fromAddr[0] != '':\n toName = ParseAddress(self.message[1])\n else:\n toName = ''\n #if self.message[5] is None:\n body = self.message[2].split('\\n')\n sender = ParseAddress(self.message[1])\n reBody = [text.wrote % sender]\n reBody.append('')\n for line in body:\n reBody.append('> '+line)\n reBody = u'\\n'.join(reBody)\n\n myDlg = SendMailDlg(parent = self)\n myDlg.ShowSendMailDlg(\n sbjct=sbjct,\n From = From,\n To = To,\n Txt = reBody,\n toName = toName,\n text = SendEmail.text,\n plugin = self.plugin,\n references = self.message[5],\n messageID = self.message[7],\n )\n self.replyButton.Bind(wx.EVT_BUTTON, onReplyButton)\n\n def onDeleteButton(evt):\n wx.CallAfter(self.parent.deleteEmails,self.message[3], self.message[4], True)\n self.messageCtrl.ChangeValue('')\n self.parent.Refresh()\n time.sleep(1)\n self.Close(True)\n self.deleteButton.Bind(wx.EVT_BUTTON, onDeleteButton)\n\n self.SetMinSize(self.GetSize())\n self.SetSize(size)\n self.SetPosition(position)\n self.Show(True)\n\n def getEmailNum(self):\n return self.message[4][0]\n\n def setTitle(self):\n title = ('%s-%s | %s: %s' % (\n self.setup[0],\n self.message[4][0],\n ParseAddress(self.message[1]),\n self.message[0]\n ))\n if len(title) > 68:\n title = title[:65]+'...'\n self.SetTitle(title)\n\n def Unblock(self, unblock):\n if unblock:\n data = self.plugin.tempData[self.message[3]][2]\n try:\n ix = [item[0] for item in data].index(self.id)\n self.message[4][0] = data[ix][4]\n self.setTitle()\n except:\n self.Close(True)\n colour = self.GetForegroundColour()\n else:\n colour = wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT)\n self.messageCtrl.SetForegroundColour(colour)\n self.deleteButton.Enable(unblock)\n self.clientButton.Enable(unblock)\n self.closeButton.Enable(unblock)\n self.Refresh()\n self.Enable(unblock)\n#===============================================================================\n\nclass DetailsFrame(wx.MiniFrame):\n messageFrame = None\n messFramSize = (-1, -1)\n messFramPosition = (-1, -1)\n\n def __init__(self, parent):\n self.parent = parent\n self.plugin = parent.plugin\n self.passINC = self.plugin.passINC\n self.setup = parent.setup\n wx.MiniFrame.__init__(\n self,\n None,\n -1,\n size=(-1, -1),\n style=wx.CAPTION|wx.RESIZE_BORDER\n )\n self.SetBackgroundColour(wx.NullColour)\n self.menuFlagS = False\n self.menuFlagD = False\n self.delFlag = False\n\n\n def ShowDetailsFrame(\n self,\n position,\n size\n ):\n self.text = self.plugin.text\n mainSizer = wx.BoxSizer(wx.VERTICAL)\n centralSizer = wx.GridBagSizer(10, 10)\n centralSizer.AddGrowableRow(0)\n centralSizer.AddGrowableCol(1)\n centralSizer.AddGrowableCol(3)\n centralSizer.AddGrowableCol(5)\n centralSizer.AddGrowableCol(7)\n self.messagesListCtrl = wx.ListCtrl(self, -1, style=wx.LC_REPORT | wx.VSCROLL | wx.HSCROLL)\n for i, labelsDetails in enumerate(self.text.labelsDetails):\n self.messagesListCtrl.InsertColumn(\n i,\n labelsDetails,\n )\n centralSizer.Add(self.messagesListCtrl, (0,0),(1,9), flag = wx.EXPAND)\n\n #Buttons\n sizes = []\n sizes.append(self.GetTextExtent(self.text.show)[0])\n sizes.append(self.GetTextExtent(self.text.delete)[0])\n sizes.append(self.GetTextExtent(self.text.refresh)[0])\n sizes.append(self.GetTextExtent(self.text.client)[0])\n sizes.append(self.GetTextExtent(self.text.close)[0])\n w=max(sizes)+12\n self.showButton = wx.Button(self, -1, self.text.show,size=((w,-1)))\n self.deleteButton = wx.Button(self, -1, self.text.delete,size=((w,-1)))\n self.refreshButton = wx.Button(self, -1, self.text.refresh,size=((w,-1)))\n self.clientButton = wx.Button(self, -1, self.text.client,size=((w,-1)))\n self.closeButton = wx.Button(self, -1, self.text.close,size=((w,-1)))\n centralSizer.Add(self.showButton,(1,0), flag = wx.ALIGN_LEFT|wx.BOTTOM,border = 10)\n centralSizer.Add(self.deleteButton,(1,2), flag = wx.ALIGN_CENTER_HORIZONTAL)\n centralSizer.Add(self.refreshButton,(1,4), flag = wx.ALIGN_CENTER_HORIZONTAL)\n centralSizer.Add(self.clientButton,(1,6), flag = wx.ALIGN_CENTER_HORIZONTAL)\n centralSizer.Add(self.closeButton,(1,8), flag = wx.ALIGN_RIGHT)\n self.messagesListCtrl.Bind(wx.EVT_COMMAND_RIGHT_CLICK, self.OnRightClick)\n self.messagesListCtrl.Bind(wx.EVT_LIST_ITEM_SELECTED, self.ListSelection)\n self.messagesListCtrl.Bind(wx.EVT_LIST_ITEM_DESELECTED, self.ListSelection)\n\n def OnSize(event):\n self.messagesListCtrl.SetColumnWidth(6, wx.LIST_AUTOSIZE_USEHEADER)\n event.Skip()\n\n self.Refresh()\n self.Bind(wx.EVT_SIZE, OnSize)\n mainSizer.Add(centralSizer, 1,wx.EXPAND|wx.LEFT|wx.RIGHT|wx.TOP,10)\n self.SetSizer(mainSizer)\n mainSizer.Fit(self)\n sizes = (40,75,200,200)\n for i in range(4):\n self.messagesListCtrl.SetColumnWidth(i, sizes[i])\n mainSizer.Layout()\n\n def OnCloseWindow(event):\n self.parent.detFramePosition = self.GetPosition()\n self.parent.detFrameSize = self.GetSize()\n if self.messageFrame:\n self.messageFrame.Close()\n self.Destroy()\n event.Skip()\n\n self.Bind(wx.EVT_CLOSE, OnCloseWindow)\n self.closeButton.Bind(wx.EVT_BUTTON, self.onCloseButton)\n self.deleteButton.Bind(wx.EVT_BUTTON, self.onDeleteButton)\n self.clientButton.Bind(wx.EVT_BUTTON, self.onClientButton)\n self.showButton.Bind(wx.EVT_BUTTON, self.onShowButton)\n self.refreshButton.Bind(wx.EVT_BUTTON, self.onRefresh)\n self.messagesListCtrl.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.onShowButton) #Doubleclick\n self.SetMinSize((565,160))\n self.SetSize(size)\n self.SetPosition(position)\n self.Show(True)\n\n def onRefresh(self,evt):\n self.Unblock(False)\n indx = [i[0] for i in self.plugin.tempData].index(self.setup[0])\n wt = self.plugin.tempData[indx][3]\n wt.operate(True)\n evt.Skip()\n\n def onShowButton(self, evt):\n item = self.messagesListCtrl.GetFirstSelected()\n nbr = self.messagesListCtrl.GetItemText(item)\n sel=[nbr]\n indx = [i[0] for i in self.plugin.tempData].index(self.setup[0])\n message = self.RealizeAction(indx, sel, 1) # 1 ~ mode 'show'\n if message:\n if self.messageFrame:\n self.messageFrame.Close()\n self.messageFrame = MessageFrame(\n parent = self,\n message = message,\n )\n wx.CallAfter(\n self.messageFrame.ShowMessageFrame,\n position = self.messFramPosition,\n size = self.messFramSize,\n )\n evt.Skip()\n\n def onCloseButton(self, evt):\n self.Close(True)\n\n def deleteEmails(self, indx, sel, close = False):\n self.delFlag = True\n if close:\n self.messageFrame.Close()\n else:\n if self.messageFrame:\n num = self.messageFrame.getEmailNum()\n rec = self.plugin.tempData[indx][2][int(num)-1]\n if num in sel or rec[0] == rec[2]:\n self.messageFrame.Close()\n else:\n self.messageFrame.Enable(False)\n self.Unblock(False)\n wt = self.plugin.tempData[indx][3]\n wt.DeleteAction((indx, sel, 0,self))\n\n def onDeleteButton(self, evt):\n item = self.messagesListCtrl.GetFirstSelected()\n sel = []\n while item != -1:\n nbr = self.messagesListCtrl.GetItemText(item)\n sel.append(nbr)\n item = self.messagesListCtrl.GetNextSelected(item)\n indx = [i[0] for i in self.plugin.tempData].index(self.setup[0])\n self.deleteEmails(indx, sel)\n evt.Skip()\n\n def onClientButton(self, evt):\n RunEmailClient(self.text)\n\n def ListSelection(self, event=None):\n if self.messageFrame:\n self.messageFrame.Raise()\n self.menuFlagS = self.messagesListCtrl.GetSelectedItemCount() == 1\n self.showButton.Enable(self.menuFlagS)\n self.menuFlagD = self.messagesListCtrl.GetFirstSelected() != -1\n self.deleteButton.Enable(self.menuFlagD)\n if event:\n event.Skip()\n\n def Disappear(self):\n if self.delFlag:\n self.Show(False)\n else:\n self.Close()\n\n def resDelFlag(self):\n self.delFlag = False\n\n def isCloseReq(self):\n return self.delFlag and not self.IsShown()\n\n def Refresh(self, event=None):\n observName = self.setup[0]\n indx = [item[0] for item in self.plugin.tempData].index(observName)\n self.messagesListCtrl.DeleteAllItems()\n row = 0\n for item in self.plugin.tempData[indx][2]:\n self.messagesListCtrl.InsertStringItem(row, item[4])\n self.messagesListCtrl.SetStringItem(row, 1,item[3])\n self.messagesListCtrl.SetStringItem(row, 2, item[1])\n self.messagesListCtrl.SetStringItem(row, 3, item[2])\n row += 1\n self.SetTitle(self.plugin.text.detTitle % (self.setup[0],str(row)))\n label = self.parent.GetNum()\n if label != row:\n self.parent.SetNum(row)\n self.Unblock(True)\n self.ListSelection()\n\n def Unblock(self, unblock):\n if unblock:\n colour = self.GetForegroundColour()\n else:\n colour = wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT)\n self.messagesListCtrl.SetTextColour(colour)\n self.deleteButton.Enable(unblock)\n self.refreshButton.Enable(unblock)\n self.clientButton.Enable(unblock)\n self.closeButton.Enable(unblock)\n self.showButton.Enable(unblock)\n self.messagesListCtrl.Refresh()\n self.Enable(unblock)\n if self.messageFrame:\n self.messageFrame.Unblock(unblock)\n\n def OnRightClick(self, event):\n if not hasattr(self, \"popupID1\"):\n self.popupID1 = wx.NewId()\n self.popupID2 = wx.NewId()\n self.popupID3 = wx.NewId()\n self.popupID4 = wx.NewId()\n self.popupID5 = wx.NewId()\n self.Bind(wx.EVT_MENU, self.onShowButton, id=self.popupID1)\n self.Bind(wx.EVT_MENU, self.onDeleteButton, id=self.popupID2)\n self.Bind(wx.EVT_MENU, self.onRefresh, id=self.popupID3)\n self.Bind(wx.EVT_MENU, self.onClientButton, id=self.popupID4)\n self.Bind(wx.EVT_MENU, self.onCloseButton, id=self.popupID5)\n # make a menu\n menu = wx.Menu()\n # add some items\n if self.menuFlagS:\n menu.Append(self.popupID1, self.text.popup[0])\n if self.menuFlagD:\n menu.Append(self.popupID2, self.text.popup[1])\n menu.Append(self.popupID3, self.text.popup[2])\n menu.Append(self.popupID4, self.text.popup[3])\n menu.Append(self.popupID5, self.text.popup[4])\n # Popup the menu. If an item is selected then its handler\n # will be called before PopupMenu returns.\n self.PopupMenu(menu)\n menu.Destroy()\n\n def RealizeAction(self, indx, sel, mode):\n obsData = self.plugin.tempData[indx][2]\n observName = self.plugin.tempData[indx][0]\n resultMessage = None\n oldAccount = ''\n m = len(sel)-1\n item = sel[m]\n ix = [i[4] for i in obsData].index(item)\n iac = [cfg[0] for cfg in self.plugin.configs].index(obsData[ix][3])\n account = self.plugin.configs[iac]\n while m > -1:\n while oldAccount == account:\n id = obsData[ix][5]\n if account[1] == 0: #POP3\n lst = mailbox.list()[1]\n cnt = len(lst)\n if cnt >= int(id):\n MAXLINES=100 #ToDo : MAXLINES choice\n if mode == 0:\n MAXLINES = 0 #Delete -> not need read\n resp, txt, octets = mailbox.top(id, MAXLINES)\n if resp != '+OK':\n resp, txt, octets = mailbox.retr(id)\n txt = \"\\n\".join(txt)\n msg=myParser.parsestr(txt)\n if msg.has_key('Message-Id'):\n messId = msg['Message-Id']\n else:\n messId = ParseAddress(msg['From'])\n if messId == obsData[ix][0]:\n if mode == 1:\n resultMessage = GetParts(msg, True)\n resultMessage[3] = indx\n resultMessage[4] = sel\n else: #mode = 0 ~ delete\n mailbox.dele(id)\n\n else: #IMAP\n typ, txt = mailbox.select('INBOX') #Folder selection\n if txt[0]:\n if mode == 1:\n typ, txt = mailbox.fetch(id, '(RFC822)')\n mailbox.store(id, \"-FLAGS\", '(\\Seen)') #Reset UNSEEN flag\n else:\n typ, txt = mailbox.fetch(id, '(RFC822.HEADER)')\n txt = txt[0][1]\n msg = myParser.parsestr(txt)\n if msg.has_key('Message-Id'):\n messId = msg['Message-Id']\n else:\n messId = ParseAddress(msg['From'])\n if messId == obsData[ix][0]:\n if mode == 1:\n resultMessage = GetParts(msg, True)\n resultMessage[3] = indx\n resultMessage[4] = sel\n else: #mode = 0 ~ delete\n mailbox.store(id, \"+FLAGS\", '(\\Deleted)')\n m -= 1\n if m == -1:\n break\n else:\n item = sel[m]\n ix = [i[4] for i in obsData].index(item)\n iac = [cfg[0] for cfg in self.plugin.configs].index(obsData[ix][3])\n account = self.plugin.configs[iac]\n\n if oldAccount != '':\n if account[1] == 0: #POP\n mailbox.quit()\n else: #IMAP\n mailbox.expunge()\n mailbox.logout()\n if m == -1:\n break\n Error = True\n while Error:\n oldAccount = account\n SERVER = account[5]\n PORT = account[6]\n USER = account[7]\n PASSWORD = self.passINC.data[account[0]]\n USE_SSL = account[9] == 3\n Error = False\n if account[1] == 0: #POP\n try:\n if USE_SSL:\n mailbox = poplib.POP3_SSL(SERVER, PORT)\n else:\n mailbox = poplib.POP3(SERVER, PORT)\n except:\n eg.PrintError(self.text.error0+' '+self.text.error1 % (SERVER,PORT))\n Error = True\n else:\n #mailbox.set_debuglevel(5)\n try:\n mailbox.user(USER)\n mailbox.pass_(PASSWORD)\n except poplib.error_proto, errmsg:\n eg.PrintError(self.text.error0+' '+str(errmsg))\n Error = True\n mailbox.quit()\n\n else: #IMAP\n try:\n if USE_SSL:\n mailbox = imaplib.IMAP4_SSL(SERVER, PORT)\n else:\n mailbox = imaplib.IMAP4(SERVER, PORT)\n except:\n eg.PrintError(self.text.error2+' '+self.text.error3 % (SERVER,PORT))\n Error = True\n else:\n try:\n mailbox.login(USER, PASSWORD)\n except:\n eg.PrintError(self.text.error2+' '+self.text.error4 % (USER, SERVER, PORT))\n Error = True\n mailbox.logout()\n if Error:\n while oldAccount == account:\n m -= 1\n if m == -1:\n Error = False\n break\n else:\n item = sel[m]\n ix = [i[4] for i in obsData].index(item)\n iac = [cfg[0] for cfg in self.plugin.configs].index(obsData[ix][3])\n account = self.plugin.configs[iac]\n\n return resultMessage\n#===============================================================================\n\nclass NotifFrame(wx.MiniFrame):\n detailsFrame = None\n detFramePosition = (-1,-1)\n detFrameSize = (-1,-1)\n\n def __init__(self, parent):\n wx.MiniFrame.__init__(\n self,\n parent,\n -1,\n '',\n size = (120, 60),\n style = wx.STAY_ON_TOP|wx.CAPTION\n )\n\n def ShowNotifFrame(\n self,\n plugin,\n stp,\n event=None\n ):\n self.plugin = plugin\n self.setup = stp\n self.SetTitle(' '+self.setup[0])\n self.SetBackgroundColour(self.setup[9])\n self.SetForegroundColour(self.setup[10])\n text = self.plugin.text\n tip = text.tip0\n self.label = wx.StaticText(self, -1, '')\n label2 = wx.StaticText(self,-1,text.notifLabel)\n font = self.label.GetFont()\n font.SetPointSize(20)\n self.label.SetFont(font)\n w = self.label.GetTextExtent(' 888 ')[0]\n self.label.SetPosition((0,1))\n label2.SetPosition((w,4))\n self.label.SetToolTipString(tip)\n label2.SetToolTipString(tip)\n self.Refresh()\n\n def OnCloseWindow(event):\n if self.detailsFrame:\n self.detailsFrame.Disappear()\n self.Destroy()\n event.Skip()\n self.Bind(wx.EVT_CLOSE, OnCloseWindow)\n\n def OnDoubleClick(evt):\n if evt.ControlDown(): #with CTRL\n RunEmailClient(text)\n else: #without CTRL\n if self.detailsFrame:\n BringWindowToTop(self.detailsFrame.GetHandle())\n else:\n self.detailsFrame = DetailsFrame(parent = self)\n wx.CallAfter(\n self.detailsFrame.ShowDetailsFrame,\n position = self.detFramePosition,\n size = self.detFrameSize\n )\n\n self.Bind(wx.EVT_LEFT_DCLICK, OnDoubleClick)\n self.label.Bind(wx.EVT_LEFT_DCLICK, OnDoubleClick)\n label2.Bind(wx.EVT_LEFT_DCLICK, OnDoubleClick)\n\n def OnRightClick(evt):\n if self.detailsFrame:\n self.detailsFrame.Disappear()\n self.Show(False)\n self.Bind(wx.EVT_RIGHT_UP, OnRightClick)\n self.label.Bind(wx.EVT_RIGHT_UP, OnRightClick)\n label2.Bind(wx.EVT_RIGHT_UP, OnRightClick)\n BringWindowToTop(self.GetHandle())\n wx.Yield()\n SetEvent(event)\n\n def Disappear(self, close=False):\n if self.detailsFrame:\n self.detailsFrame.Disappear()\n if not close:\n self.Show(False)\n else:\n self.Close()\n\n def GetNum(self):\n return int(self.label.GetLabel())\n\n def SetNum(\n self,\n label=\"\",\n ):\n lbl = str(label)\n if label<10:\n lbl = \" %s \" % lbl\n elif label<100:\n lbl = \" %s \" % lbl\n else:\n lbl = \" %s \" % lbl\n self.label.SetLabel(lbl)\n if self.detailsFrame:\n wx.CallAfter(self.detailsFrame.Refresh)\n#===============================================================================\n\nclass outServerDialog(wx.MiniFrame):\n oldSel = 0\n def __init__(self, parent, plugin):\n wx.MiniFrame.__init__(\n self,\n parent,\n -1,\n style=wx.CAPTION,\n name=\"Servers dialog\"\n )\n self.panel = parent\n self.passSMTP = {}\n for i,item in list(enumerate(self.panel.passSMTP)):\n self.passSMTP[item]=self.panel.passSMTP[item]\n self.plugin = plugin\n self.servers = cpy(self.panel.servers)\n self.cfgs = cpy(self.panel.cfgs)\n self.val = self.panel.outServerCtrl.GetStringSelection()\n self.SetBackgroundColour(wx.NullColour)\n#===============================================================================\n\n def ShowOutServDlg(self):\n def boxEnable(enable):\n labelCtrl.Enable(enable)\n labelLbl.Enable(enable)\n outServerLbl.Enable(enable)\n outServerCtrl.Enable(enable)\n outPortLbl.Enable(enable)\n outPortCtrl.Enable(enable)\n choiceSecureLbl.Enable(enable)\n choiceSecureCtrl.Enable(enable)\n useSecureCtrl.Enable(enable)\n\n def setValue(item):\n labelCtrl.ChangeValue (item[0])\n outServerCtrl.SetValue(item[1])\n outPortCtrl.SetValue(item[2])\n choiceSecureCtrl.SetSelection(item[3])\n useSecureCtrl.SetValue(item[4])\n userCtrl.SetValue(item[5])\n if item[0] != '' and item[0] in self.passSMTP:\n passwCtrl.ChangeValue(self.passSMTP[item[0]])\n else:\n passwCtrl.ChangeValue('')\n\n def validation():\n flag = True\n label = labelCtrl.GetValue()\n if label == \"\":\n flag = False\n else:\n if [n[0] for n in self.servers].count(label)!=1:\n flag = False\n if outServerCtrl.GetValue() == '':\n flag = False\n if outPortCtrl.GetValue() < 0:\n flag = False\n if useSecureCtrl.GetValue():\n if userCtrl.GetValue() == '' or passwCtrl.GetValue() == '':\n flag = False\n btn1.Enable(flag)\n btnApp.Enable(flag)\n\n text = self.plugin.text\n self.SetTitle(text.outServerTitle)\n sizer = wx.BoxSizer(wx.VERTICAL)\n sizer.SetMinSize((450, 308))\n leftSizer = wx.FlexGridSizer(4,2,2,8)\n topMiddleSizer=wx.BoxSizer(wx.VERTICAL)\n previewLbl=wx.StaticText(self, -1, text.serversList)\n listBoxCtrl=wx.ListBox(\n self,-1,\n size=wx.Size(120,106),\n style=wx.LB_SINGLE|wx.LB_NEEDED_SB\n )\n labelLbl=wx.StaticText(self, -1, text.servLabel)\n labelCtrl=wx.TextCtrl(self,-1,'')\n box = wx.StaticBox(self,-1,text.servParam)\n rightSizer = wx.StaticBoxSizer(box,wx.VERTICAL)\n #Box content\n outServerLbl=wx.StaticText(self, -1, text.outServer)\n outServerCtrl=wx.TextCtrl(self,-1,'')\n outPortLbl=wx.StaticText(self, -1, text.incPort)\n outPortCtrl=intCtrl(self,-1,25,size=(50,-1))\n choiceSecureLbl =wx.StaticText(self, -1, text.secureConnectLabel)\n choiceSecureCtrl = wx.Choice(\n self,\n -1,\n choices=(text.secureConnectChoice2),\n )\n choiceSecureCtrl.SetMaxSize((194,-1))\n useSecureCtrl = wx.CheckBox(self, label = text.useName)\n userLbl=wx.StaticText(self, -1, text.userLogin)\n userCtrl=wx.TextCtrl(self,-1,'')\n userCtrl.SetMaxSize((194,-1))\n passwLbl=wx.StaticText(self, -1, text.userPassword)\n passwCtrl=wx.TextCtrl(self,-1,'',style = wx.TE_PASSWORD)\n passwCtrl.SetMaxSize((194,-1))\n serverSizer = wx.BoxSizer(wx.HORIZONTAL)\n serverSizerL = wx.BoxSizer(wx.VERTICAL)\n serverSizerR = wx.BoxSizer(wx.VERTICAL)\n serverSizer.Add(serverSizerL,1,wx.EXPAND)\n serverSizer.Add(serverSizerR,0,wx.EXPAND|wx.LEFT,5)\n serverSizerL.Add(outServerLbl,0,wx.EXPAND)\n serverSizerL.Add(outServerCtrl,0,wx.EXPAND)\n serverSizerR.Add(outPortLbl,0,wx.EXPAND|wx.LEFT,3)\n serverSizerR.Add(outPortCtrl,0,wx.EXPAND)\n rightSizer.Add(choiceSecureLbl,0,wx.TOP,5)\n rightSizer.Add(choiceSecureCtrl,0,wx.EXPAND|wx.TOP,3)\n rightSizer.Add(serverSizer,0,wx.EXPAND|wx.TOP,10)\n rightSizer.Add(useSecureCtrl,0,wx.TOP,16)\n rightSizer.Add(userLbl,0,wx.TOP,5)\n rightSizer.Add(userCtrl,0,wx.EXPAND|wx.TOP|wx.BOTTOM,3)\n rightSizer.Add(passwLbl,0,wx.TOP,5)\n rightSizer.Add(passwCtrl,0,wx.EXPAND|wx.TOP|wx.BOTTOM,3)\n rightSizer.Add((1,3))\n leftSizer.Add(previewLbl,0,wx.TOP,5)\n leftSizer.Add((1,1))\n leftSizer.Add(listBoxCtrl,0,wx.TOP,5)\n leftSizer.Add(topMiddleSizer,0,wx.TOP,5)\n leftSizer.Add(labelLbl,0,wx.TOP,3)\n leftSizer.Add((1,1))\n leftSizer.Add(labelCtrl,0,wx.EXPAND)\n leftSizer.Add((1,1))\n #Button UP\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_UP, wx.ART_OTHER, (16, 16))\n btnUP = wx.BitmapButton(self, -1, bmp)\n btnUP.Enable(False)\n topMiddleSizer.Add(btnUP)\n #Button DOWN\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_DOWN, wx.ART_OTHER, (16, 16))\n btnDOWN = wx.BitmapButton(self, -1, bmp)\n btnDOWN.Enable(False)\n topMiddleSizer.Add(btnDOWN,0,wx.TOP,3)\n #Buttons 'Delete' and 'Insert new'\n w1 = self.GetTextExtent(text.delete)[0]\n w2 = self.GetTextExtent(text.insert)[0]\n if w1 > w2:\n btnDEL=wx.Button(self,-1,text.delete)\n btnApp=wx.Button(self,-1,text.insert,size=btnDEL.GetSize())\n else:\n btnApp=wx.Button(self,-1,text.insert)\n btnDEL=wx.Button(self,-1,text.delete,size=btnApp.GetSize())\n btnDEL.Enable(False)\n topMiddleSizer.Add(btnDEL,0,wx.TOP,5)\n topMiddleSizer.Add(btnApp,0,wx.TOP,5)\n mainSizer = wx.BoxSizer(wx.HORIZONTAL)\n mainSizer.Add(leftSizer,0,wx.LEFT,10)\n mainSizer.Add(rightSizer,0,wx.EXPAND|wx.LEFT|wx.RIGHT|wx.TOP,14)\n sizer.Add(mainSizer,0,wx.TOP,10)\n line = wx.StaticLine(self, -1, size=(20,-1),pos = (200,0), style=wx.LI_HORIZONTAL)\n btn1 = wx.Button(self, wx.ID_OK)\n btn1.SetLabel(text.ok)\n btn1.Enable(False)\n btn1.SetDefault()\n btn2 = wx.Button(self, wx.ID_CANCEL)\n btn2.SetLabel(text.cancel)\n btnsizer = wx.StdDialogButtonSizer()\n btnsizer.AddButton(btn1)\n btnsizer.AddButton(btn2)\n btnsizer.Realize()\n sizer.Add((1,12))\n sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.TOP|wx.BOTTOM,5)\n sizer.Add(btnsizer, 0, wx.EXPAND|wx.RIGHT, 10)\n self.SetSizer(sizer)\n sizer.Fit(self)\n#===============================================================================\n\n def onClose(evt):\n self.MakeModal(False)\n self.GetParent().GetParent().Raise()\n self.Destroy()\n self.Bind(wx.EVT_CLOSE, onClose)\n\n def onCancel(evt):\n self.Close()\n btn2.Bind(wx.EVT_BUTTON,onCancel)\n\n def onOK(evt):\n self.panel.servers = self.servers\n self.panel.cfgs = self.cfgs\n self.panel.passSMTP = self.passSMTP\n self.panel.outServerCtrl.Clear()\n self.panel.outServerCtrl.AppendItems(strings=[n[0] for n in self.servers])\n self.panel.outServerCtrl.SetStringSelection(self.val)\n self.panel.validation()\n self.Close()\n btn1.Bind(wx.EVT_BUTTON,onOK)\n\n def OnLabelAndPassword(evt):\n if self.servers <> []:\n srvrs = [item[8] for item in self.cfgs]\n oldLbl = listBoxCtrl.GetStringSelection()\n sel = self.oldSel\n label = labelCtrl.GetValue().strip()\n val = passwCtrl.GetValue()\n if val != '':\n self.passSMTP[label] = val\n self.servers[sel][0]=label\n if listBoxCtrl.GetStrings().count(oldLbl)==1:\n if oldLbl in srvrs:\n if self.val == oldLbl:\n self.val = label\n for item in self.cfgs:\n if item[8] == oldLbl:\n item[8] = label\n listBoxCtrl.Set([n[0] for n in self.servers])\n listBoxCtrl.SetSelection(sel)\n validation()\n evt.Skip()\n labelCtrl.Bind(wx.EVT_TEXT, OnLabelAndPassword)\n passwCtrl.Bind(wx.EVT_TEXT, OnLabelAndPassword)\n\n def onServerName(event):\n if self.servers<>[]:\n val = outServerCtrl.GetValue().strip()\n sel = self.oldSel\n self.servers[sel][1] = val\n validation()\n event.Skip()\n outServerCtrl.Bind(wx.EVT_TEXT, onServerName)\n\n def onPort(event):\n if self.servers<>[]:\n val = outPortCtrl.GetValue()\n sel = self.oldSel\n self.servers[sel][2] = val\n validation()\n event.Skip()\n outPortCtrl.Bind(wx.EVT_TEXT, onPort)\n\n def onSSL(event):\n if self.servers<>[]:\n ports=(25,587,587,465)\n val = choiceSecureCtrl.GetSelection()\n port = ports[val]\n outPortCtrl.SetValue(port)\n sel = self.oldSel\n self.servers[sel][2] = port\n self.servers[sel][3] = val\n validation()\n event.Skip()\n choiceSecureCtrl.Bind(wx.EVT_CHOICE, onSSL)\n\n def onCheckbox(event=None):\n val = useSecureCtrl.GetValue()\n sel = self.oldSel\n self.servers[sel][4] = val\n userCtrl.Enable(val)\n userLbl.Enable(val)\n passwCtrl.Enable(val)\n passwLbl.Enable(val)\n if not val:\n userCtrl.SetValue('')\n passwCtrl.SetValue('')\n validation()\n if event:\n event.Skip()\n useSecureCtrl.Bind(wx.EVT_CHECKBOX,onCheckbox)\n\n def onUser(event):\n if self.servers<>[]:\n val = userCtrl.GetValue().strip()\n sel = self.oldSel\n self.servers[sel][5] = val\n validation()\n event.Skip()\n userCtrl.Bind(wx.EVT_TEXT, onUser)\n\n def onClick(evt):\n sel = listBoxCtrl.GetSelection()\n label = labelCtrl.GetValue()\n if label.strip() <> \"\":\n if [n[0] for n in self.servers].count(label) == 1:\n self.oldSel=sel\n item = self.servers[sel]\n setValue(item)\n listBoxCtrl.SetSelection(self.oldSel)\n listBoxCtrl.SetFocus()\n val = self.servers[sel][4]\n userCtrl.Enable(val)\n userLbl.Enable(val)\n passwCtrl.Enable(val)\n passwLbl.Enable(val)\n validation()\n evt.Skip()\n listBoxCtrl.Bind(wx.EVT_LISTBOX, onClick)\n\n def onButtonUp(evt):\n newSel,self.servers=Move(self.servers,listBoxCtrl.GetSelection(),-1)\n listBoxCtrl.Set([n[0] for n in self.servers])\n listBoxCtrl.SetSelection(newSel)\n self.oldSel = newSel\n evt.Skip()\n btnUP.Bind(wx.EVT_BUTTON, onButtonUp)\n\n def onButtonDown(evt):\n newSel,self.servers=Move(self.servers,listBoxCtrl.GetSelection(),1)\n listBoxCtrl.Set([n[0] for n in self.servers])\n listBoxCtrl.SetSelection(newSel)\n self.oldSel = newSel\n evt.Skip()\n btnDOWN.Bind(wx.EVT_BUTTON, onButtonDown)\n\n def onButtonDelete(evt):\n srvrs = [item[8] for item in self.cfgs]\n val = listBoxCtrl.GetStringSelection()\n if val in srvrs:\n answer = wx.MessageBox(\n text.deleteServer % val,\n eg.APP_NAME,\n wx.NO_DEFAULT|wx.OK|wx.ICON_EXCLAMATION\n )\n return\n sel = listBoxCtrl.GetSelection()\n lngth = len(self.servers)\n if lngth == 2:\n btnUP.Enable(False)\n btnDOWN.Enable(False)\n if lngth == 1:\n self.servers=[]\n listBoxCtrl.Set([])\n item = ['','',25,0,False,'']\n setValue(item)\n boxEnable(False)\n btn1.Enable(False)\n btnDEL.Enable(False)\n btnApp.Enable(True)\n userCtrl.Enable(False)\n userLbl.Enable(False)\n passwCtrl.Enable(False)\n passwLbl.Enable(False)\n evt.Skip()\n return\n elif sel == lngth - 1:\n sel = 0\n self.oldSel = sel\n tmp = self.servers.pop(listBoxCtrl.GetSelection())\n listBoxCtrl.Set([n[0] for n in self.servers])\n listBoxCtrl.SetSelection(sel)\n item = self.servers[sel]\n setValue(item)\n onCheckbox()\n evt.Skip()\n btnDEL.Bind(wx.EVT_BUTTON, onButtonDelete)\n\n def OnButtonAppend(evt):\n if len(self.servers)==1:\n btnUP.Enable(True)\n btnDOWN.Enable(True)\n boxEnable(True)\n sel = listBoxCtrl.GetSelection() + 1\n self.oldSel=sel\n item = ['','',25,0,False,'']\n self.servers.insert(sel,item)\n listBoxCtrl.Set([n[0] for n in self.servers])\n listBoxCtrl.SetSelection(sel)\n setValue(item)\n labelCtrl.SetFocus()\n btnApp.Enable(False)\n btnDEL.Enable(True)\n onCheckbox()\n evt.Skip()\n\n if len(self.servers) > 0:\n listBoxCtrl.Set([n[0] for n in self.servers])\n listBoxCtrl.SetSelection(0)\n setValue(self.servers[0])\n self.oldSel=0\n btnUP.Enable(True)\n btnDOWN.Enable(True)\n btnDEL.Enable(True)\n onCheckbox()\n else:\n boxEnable(False)\n btn1.Enable(False)\n btnApp.Enable(True)\n userCtrl.Enable(False)\n userLbl.Enable(False)\n passwCtrl.Enable(False)\n passwLbl.Enable(False)\n\n btnApp.Bind(wx.EVT_BUTTON, OnButtonAppend)\n sizer.Layout()\n self.MakeModal(True)\n self.SetFocus()\n self.Show()\n#===============================================================================\n\nclass outTextsDialog(wx.MiniFrame):\n oldSel = 0\n def __init__(self, parent, plugin):\n wx.MiniFrame.__init__(\n self,\n parent,\n -1,\n style=wx.CAPTION,\n name=\"Texts dialog\"\n )\n self.SetBackgroundColour(wx.NullColour)\n self.panel = parent\n self.plugin = plugin\n self.texts = cpy(self.panel.txts)\n#===============================================================================\n\n def ShowOutTxtsDlg(self):\n text = self.plugin.text\n self.SetTitle(text.textsTitle)\n sizer = wx.BoxSizer(wx.VERTICAL)\n sizer.SetMinSize((450, 300))\n leftSizer = wx.FlexGridSizer(4,2,2,8)\n topMiddleSizer=wx.BoxSizer(wx.VERTICAL)\n previewLbl=wx.StaticText(self, -1, text.textsList)\n listBoxCtrl=wx.ListBox(\n self,-1,\n size=wx.Size(120,106),\n style=wx.LB_SINGLE|wx.LB_NEEDED_SB\n )\n labelLbl=wx.StaticText(self, -1, text.txtLabel)\n labelCtrl=wx.TextCtrl(self,-1,'')\n rightSizer = wx.BoxSizer(wx.VERTICAL)\n outTextLbl=wx.StaticText(self, -1, text.outText)\n outTextCtrl=wx.TextCtrl(\n self,-1,'',size=(210, 232),\n style=wx.TE_MULTILINE|wx.TE_PROCESS_ENTER\n )\n rightSizer.Add(outTextLbl,0,wx.EXPAND)\n rightSizer.Add(outTextCtrl,0,wx.EXPAND)\n leftSizer.Add(previewLbl,0,wx.TOP,5)\n leftSizer.Add((1,1))\n leftSizer.Add(listBoxCtrl,0,wx.TOP,5)\n leftSizer.Add(topMiddleSizer,0,wx.TOP,5)\n leftSizer.Add(labelLbl,0,wx.TOP,3)\n leftSizer.Add((1,1))\n leftSizer.Add(labelCtrl,0,wx.EXPAND)\n leftSizer.Add((1,1))\n #Button UP\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_UP, wx.ART_OTHER, (16, 16))\n btnUP = wx.BitmapButton(self, -1, bmp)\n btnUP.Enable(False)\n topMiddleSizer.Add(btnUP)\n #Button DOWN\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_DOWN, wx.ART_OTHER, (16, 16))\n btnDOWN = wx.BitmapButton(self, -1, bmp)\n btnDOWN.Enable(False)\n topMiddleSizer.Add(btnDOWN,0,wx.TOP,3)\n #Buttons 'Delete' and 'Insert new'\n w1 = self.GetTextExtent(text.delete)[0]\n w2 = self.GetTextExtent(text.insert)[0]\n if w1 > w2:\n btnDEL=wx.Button(self,-1,text.delete)\n btnApp=wx.Button(self,-1,text.insert,size=btnDEL.GetSize())\n else:\n btnApp=wx.Button(self,-1,text.insert)\n btnDEL=wx.Button(self,-1,text.delete,size=btnApp.GetSize())\n btnDEL.Enable(False)\n topMiddleSizer.Add(btnDEL,0,wx.TOP,5)\n topMiddleSizer.Add(btnApp,0,wx.TOP,5)\n mainSizer = wx.BoxSizer(wx.HORIZONTAL)\n mainSizer.Add(leftSizer,0,wx.LEFT,10)\n mainSizer.Add(rightSizer,0,wx.EXPAND|wx.LEFT|wx.RIGHT,14)\n sizer.Add(mainSizer,0,wx.TOP,10)\n line = wx.StaticLine(self, -1, size=(20,-1),pos = (200,0), style=wx.LI_HORIZONTAL)\n btn1 = wx.Button(self, wx.ID_OK)\n btn1.SetLabel(text.ok)\n btn1.Enable(False)\n btn1.SetDefault()\n btn2 = wx.Button(self, wx.ID_CANCEL)\n btn2.SetLabel(text.cancel)\n btnsizer = wx.StdDialogButtonSizer()\n btnsizer.AddButton(btn1)\n btnsizer.AddButton(btn2)\n btnsizer.Realize()\n sizer.Add((1,5))\n sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.TOP|wx.BOTTOM,5)\n sizer.Add(btnsizer, 0, wx.EXPAND|wx.RIGHT, 10)\n self.SetSizer(sizer)\n sizer.Fit(self)\n\n def boxEnable(enable):\n labelCtrl.Enable(enable)\n outTextCtrl.Enable(enable)\n labelLbl.Enable(enable)\n outTextLbl.Enable(enable)\n\n def setValue(item):\n labelCtrl.ChangeValue (item[0])\n outTextCtrl.ChangeValue(item[1])\n\n if len(self.texts) > 0:\n listBoxCtrl.Set([n[0] for n in self.texts])\n listBoxCtrl.SetSelection(0)\n setValue(self.texts[0])\n self.oldSel=0\n btnUP.Enable(True)\n btnDOWN.Enable(True)\n btnDEL.Enable(True)\n else:\n boxEnable(False)\n btn1.Enable(False)\n\n sizer.Layout()\n self.MakeModal(True)\n self.SetFocus()\n self.Show()\n#===============================================================================\n\n def onClose(evt):\n self.MakeModal(False)\n self.GetParent().GetParent().Raise()\n self.Destroy()\n self.Bind(wx.EVT_CLOSE, onClose)\n\n def onCancel(evt):\n self.Close()\n btn2.Bind(wx.EVT_BUTTON,onCancel)\n\n def onOK(evt):\n self.panel.txts = self.texts\n self.Close()\n btn1.Bind(wx.EVT_BUTTON,onOK)\n\n def validation():\n flag = True\n label = labelCtrl.GetValue()\n if label == \"\":\n flag = False\n else:\n if [n[0] for n in self.texts].count(label)!=1:\n flag = False\n if outTextCtrl.GetValue().strip() == '':\n flag = False\n btn1.Enable(flag)\n btnApp.Enable(flag)\n\n def OnTxtChange(evt):\n if self.texts<>[]:\n sel = self.oldSel\n label = labelCtrl.GetValue().strip()\n self.texts[sel][0]=label\n listBoxCtrl.Set([n[0] for n in self.texts])\n listBoxCtrl.SetSelection(sel)\n validation()\n evt.Skip()\n labelCtrl.Bind(wx.EVT_TEXT, OnTxtChange)\n\n def ontextName(event):\n if self.texts<>[]:\n val = outTextCtrl.GetValue().strip()\n sel = self.oldSel\n self.texts[sel][1] = val\n validation()\n event.Skip()\n outTextCtrl.Bind(wx.EVT_TEXT, ontextName)\n\n def onClick(evt):\n sel = listBoxCtrl.GetSelection()\n label = labelCtrl.GetValue()\n if label.strip()<>\"\":\n if [n[0] for n in self.texts].count(label)==1:\n self.oldSel=sel\n item = self.texts[sel]\n setValue(item)\n listBoxCtrl.SetSelection(self.oldSel)\n listBoxCtrl.SetFocus()\n evt.Skip()\n listBoxCtrl.Bind(wx.EVT_LISTBOX, onClick)\n\n def onButtonUp(evt):\n newSel,self.texts=Move(self.texts,listBoxCtrl.GetSelection(),-1)\n listBoxCtrl.Set([n[0] for n in self.texts])\n listBoxCtrl.SetSelection(newSel)\n self.oldSel = newSel\n evt.Skip()\n btnUP.Bind(wx.EVT_BUTTON, onButtonUp)\n\n def onButtonDown(evt):\n newSel,self.texts=Move(self.texts,listBoxCtrl.GetSelection(),1)\n listBoxCtrl.Set([n[0] for n in self.texts])\n listBoxCtrl.SetSelection(newSel)\n self.oldSel = newSel\n evt.Skip()\n btnDOWN.Bind(wx.EVT_BUTTON, onButtonDown)\n\n def onButtonDelete(evt):\n lngth=len(self.texts)\n if lngth==2:\n btnUP.Enable(False)\n btnDOWN.Enable(False)\n sel = listBoxCtrl.GetSelection()\n if lngth == 1:\n self.texts=[]\n listBoxCtrl.Set([])\n item = ['','']\n setValue(item)\n boxEnable(False)\n btn1.Enable(False)\n btnDEL.Enable(False)\n btnApp.Enable(True)\n evt.Skip()\n return\n elif sel == lngth - 1:\n sel = 0\n self.oldSel = sel\n tmp = self.texts.pop(listBoxCtrl.GetSelection())\n listBoxCtrl.Set([n[0] for n in self.texts])\n listBoxCtrl.SetSelection(sel)\n item = self.texts[sel]\n setValue(item)\n evt.Skip()\n btnDEL.Bind(wx.EVT_BUTTON, onButtonDelete)\n\n def OnButtonAppend(evt):\n if len(self.texts)==1:\n btnUP.Enable(True)\n btnDOWN.Enable(True)\n boxEnable(True)\n sel = listBoxCtrl.GetSelection() + 1\n self.oldSel=sel\n item = ['','']\n self.texts.insert(sel,item)\n listBoxCtrl.Set([n[0] for n in self.texts])\n listBoxCtrl.SetSelection(sel)\n setValue(item)\n labelCtrl.SetFocus()\n btnApp.Enable(False)\n btnDEL.Enable(True)\n evt.Skip()\n btnApp.Bind(wx.EVT_BUTTON, OnButtonAppend)\n#===============================================================================\n\nclass groupsDialog(wx.MiniFrame):\n oldSel = 0\n oldSel2 = 0\n def __init__(self, parent, plugin):\n wx.MiniFrame.__init__(\n self,\n parent,\n -1,\n style=wx.CAPTION,\n name=\"Groups dialog\"\n )\n self.SetBackgroundColour(wx.NullColour)\n self.panel = parent\n self.plugin = plugin\n self.groups = cpy(self.panel.grps)\n#===============================================================================\n\n def ShowGroupsDlg(self):\n text = self.plugin.text\n self.SetTitle(text.groupsTitle)\n sizer = wx.BoxSizer(wx.VERTICAL)\n sizer.SetMinSize((450, 307))\n leftSizer = wx.FlexGridSizer(4,2,2,8)\n rightSizer = wx.FlexGridSizer(4,2,2,8)\n topMiddleSizer=wx.BoxSizer(wx.VERTICAL)\n topMiddleSizer2=wx.BoxSizer(wx.VERTICAL)\n previewLbl=wx.StaticText(self, -1, text.groupsList)\n listBoxCtrl=wx.ListBox(\n self,-1,\n size=wx.Size(100,146),\n style=wx.LB_SINGLE|wx.LB_NEEDED_SB\n )\n labelLbl=wx.StaticText(self, -1, text.groupLabel)\n labelCtrl=wx.TextCtrl(self,-1,'')\n leftSizer.Add(previewLbl,0,wx.TOP,5)\n leftSizer.Add((1,1))\n leftSizer.Add(listBoxCtrl,0,wx.TOP,1)\n leftSizer.Add(topMiddleSizer,0,wx.TOP,1)\n leftSizer.Add(labelLbl,0,wx.TOP,3)\n leftSizer.Add((1,1))\n leftSizer.Add(labelCtrl,0,wx.EXPAND)\n leftSizer.Add((1,1))\n\n #Button UP\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_UP, wx.ART_OTHER, (16, 16))\n btnUP = wx.BitmapButton(self, -1, bmp)\n btnUP.Enable(False)\n topMiddleSizer.Add(btnUP)\n #Button DOWN\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_DOWN, wx.ART_OTHER, (16, 16))\n btnDOWN = wx.BitmapButton(self, -1, bmp)\n btnDOWN.Enable(False)\n topMiddleSizer.Add(btnDOWN,0,wx.TOP,3)\n #Buttons 'Delete' and 'Insert new'\n w1 = self.GetTextExtent(text.delete)[0]\n w2 = self.GetTextExtent(text.insert)[0]\n w = max(w1,w2)+24\n btnApp=wx.Button(self,-1,text.insert,size = (w,-1))\n btnDEL=wx.Button(self,-1,text.delete,size = (w,-1))\n btnDEL.Enable(False)\n topMiddleSizer.Add(btnDEL,0,wx.TOP,5)\n topMiddleSizer.Add(btnApp,0,wx.TOP,5)\n addressesLbl=wx.StaticText(self, -1, text.outAddress)\n listBoxCtrl2=wx.ListBox(\n self,-1,\n size=wx.Size(140,146),\n style=wx.LB_SINGLE|wx.LB_NEEDED_SB\n )\n labelLbl2=wx.StaticText(self, -1, text.addressLabel)\n labelCtrl2=wx.TextCtrl(self,-1,'')\n rightSizer.Add(addressesLbl,0,wx.TOP,5)\n rightSizer.Add((1,1))\n rightSizer.Add(listBoxCtrl2,0,wx.TOP,1)\n rightSizer.Add(topMiddleSizer2,0,wx.TOP,1)\n rightSizer.Add(labelLbl2,0,wx.TOP,3)\n rightSizer.Add((1,1))\n rightSizer.Add(labelCtrl2,0,wx.EXPAND)\n rightSizer.Add((1,1))\n\n #Button UP\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_UP, wx.ART_OTHER, (16, 16))\n btnUP2 = wx.BitmapButton(self, -1, bmp)\n btnUP2.Enable(False)\n topMiddleSizer2.Add(btnUP2)\n #Button DOWN\n bmp = wx.ArtProvider.GetBitmap(wx.ART_GO_DOWN, wx.ART_OTHER, (16, 16))\n btnDOWN2 = wx.BitmapButton(self, -1, bmp)\n btnDOWN2.Enable(False)\n topMiddleSizer2.Add(btnDOWN2,0,wx.TOP,3)\n #Buttons 'Delete' and 'Insert new'\n btnApp2=wx.Button(self,-1,text.insert,size = (w,-1))\n btnDEL2=wx.Button(self,-1,text.delete,size = (w,-1))\n btnDEL2.Enable(False)\n topMiddleSizer2.Add(btnDEL2,0,wx.TOP,5)\n topMiddleSizer2.Add(btnApp2,0,wx.TOP,5)\n mainSizer = wx.GridBagSizer(0, 0)\n mainSizer.AddGrowableCol(1)\n mainSizer.Add(leftSizer,(0,0),flag = wx.ALIGN_LEFT)\n mainSizer.Add(rightSizer,(0,2),flag = wx.ALIGN_RIGHT)\n sizer.Add(mainSizer,0,wx.LEFT|wx.RIGHT|wx.TOP|wx.EXPAND,20)\n line = wx.StaticLine(self, -1, size=(20,-1),pos = (200,0), style=wx.LI_HORIZONTAL)\n btn1 = wx.Button(self, wx.ID_OK)\n btn1.SetLabel(text.ok)\n btn1.Enable(False)\n btn1.SetDefault()\n btn2 = wx.Button(self, wx.ID_CANCEL)\n btn2.SetLabel(text.cancel)\n btnsizer = wx.StdDialogButtonSizer()\n btnsizer.AddButton(btn1)\n btnsizer.AddButton(btn2)\n btnsizer.Realize()\n sizer.Add((1,36))\n sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.TOP|wx.BOTTOM,5)\n sizer.Add(btnsizer, 0, wx.EXPAND|wx.RIGHT, 10)\n self.SetSizer(sizer)\n sizer.Fit(self)\n\n def boxDisable():\n addressesLbl.Enable(False)\n listBoxCtrl2.Enable(False)\n labelLbl2.Enable(False)\n labelCtrl2.Enable(False)\n btnUP2.Enable(False)\n btnDOWN2.Enable(False)\n btnApp2.Enable(False)\n btnDEL2.Enable(False)\n\n def setValue(item):\n labelCtrl.ChangeValue (item[0])\n listBoxCtrl2.Set(item[1])\n if len(item[1]) == 0:\n btnDEL2.Enable(False)\n btnUP2.Enable(False)\n btnDOWN2.Enable(False)\n else:\n listBoxCtrl2.SetSelection(0)\n labelCtrl2.ChangeValue(item[1][0])\n btnDEL2.Enable(True)\n flag = len(item[1]) > 1\n btnUP2.Enable(flag)\n btnDOWN2.Enable(flag)\n\n if len(self.groups) > 0:\n listBoxCtrl.Set([n[0] for n in self.groups])\n listBoxCtrl.SetSelection(0)\n setValue(self.groups[0])\n self.oldSel=0\n btnUP.Enable(True)\n btnDOWN.Enable(True)\n btnDEL.Enable(True)\n else:\n labelLbl.Enable(False)\n labelCtrl.Enable(False)\n btn1.Enable(False)\n boxDisable()\n\n sizer.Layout()\n self.MakeModal(True)\n self.SetFocus()\n self.Show()\n#===============================================================================\n\n def onClose(evt):\n self.MakeModal(False)\n self.GetParent().GetParent().Raise()\n self.Destroy()\n self.Bind(wx.EVT_CLOSE, onClose)\n\n def onCancel(evt):\n self.Close()\n btn2.Bind(wx.EVT_BUTTON,onCancel)\n\n def onOK(evt):\n self.panel.grps = self.groups\n self.Close()\n btn1.Bind(wx.EVT_BUTTON,onOK)\n\n def validation():\n while True:\n flag = True\n flag2 = True\n label = labelCtrl.GetValue()\n if label == '':\n flag2 = False\n if len(self.groups) > 0:\n strings = listBoxCtrl.GetStrings()\n for lbl in strings:\n if lbl == '':\n flag = False\n break\n if strings.count(label) != 1:\n flag = False\n break\n sel = self.oldSel\n address = labelCtrl2.GetValue()\n if len(self.groups[sel][1]) > 0:\n if address == '':\n flag2 = False\n break\n strings = listBoxCtrl2.GetStrings()\n for addrss in strings:\n if not validateEmailAddr(addrss):\n flag2 = False\n break\n if strings.count(address) != 1:\n flag2 = False\n break\n else:\n flag = False\n break\n btnApp2.Enable(flag2)\n btn1.Enable(flag and flag2)\n btnApp.Enable(flag and flag2)\n\n def OnTxtChange(evt):\n if self.groups<>[]:\n sel = self.oldSel\n label = labelCtrl.GetValue().strip()\n self.groups[sel][0]=label\n listBoxCtrl.Set([n[0] for n in self.groups])\n listBoxCtrl.SetSelection(sel)\n validation()\n evt.Skip()\n labelCtrl.Bind(wx.EVT_TEXT, OnTxtChange)\n\n def onClick(evt):\n sel = listBoxCtrl.GetSelection()\n if self.oldSel != sel:\n flag = True\n for address in self.groups[self.oldSel][1]:\n if not validateEmailAddr(address):\n flag = False\n break\n label = labelCtrl.GetValue()\n if label.strip()<>\"\":\n if [n[0] for n in self.groups].count(label)>1:\n flag = False\n if flag:\n self.oldSel=sel\n item = self.groups[sel]\n setValue(item)\n listBoxCtrl.SetSelection(self.oldSel)\n listBoxCtrl.SetFocus()\n #evt.Skip()\n listBoxCtrl.Bind(wx.EVT_LISTBOX, onClick)\n\n def onButtonUp(evt):\n newSel,self.groups=Move(self.groups,listBoxCtrl.GetSelection(),-1)\n listBoxCtrl.Set([n[0] for n in self.groups])\n listBoxCtrl.SetSelection(newSel)\n self.oldSel = newSel\n evt.Skip()\n btnUP.Bind(wx.EVT_BUTTON, onButtonUp)\n\n def onButtonDown(evt):\n newSel,self.groups=Move(self.groups,listBoxCtrl.GetSelection(),1)\n listBoxCtrl.Set([n[0] for n in self.groups])\n listBoxCtrl.SetSelection(newSel)\n self.oldSel = newSel\n evt.Skip()\n btnDOWN.Bind(wx.EVT_BUTTON, onButtonDown)\n\n def onButtonDelete(evt):\n lngth=len(self.groups)\n if lngth==2:\n btnUP.Enable(False)\n btnDOWN.Enable(False)\n sel = listBoxCtrl.GetSelection()\n if lngth == 1:\n self.groups=[]\n listBoxCtrl.Set([])\n item = ['', []]\n setValue(item)\n labelCtrl2.ChangeValue('')\n labelLbl.Enable(False)\n labelCtrl.Enable(False)\n boxDisable()\n btnApp2.Enable(False)\n btn1.Enable(False)\n btnDEL.Enable(False)\n btnApp.Enable(True)\n evt.Skip()\n return\n elif sel == lngth - 1:\n sel = 0\n self.oldSel = sel\n tmp = self.groups.pop(listBoxCtrl.GetSelection())\n listBoxCtrl.Set([n[0] for n in self.groups])\n listBoxCtrl.SetSelection(sel)\n item = self.groups[sel]\n setValue(item)\n evt.Skip()\n btnDEL.Bind(wx.EVT_BUTTON, onButtonDelete)\n\n def OnButtonAppend(evt):\n if len(self.groups)==1:\n btnUP.Enable(True)\n btnDOWN.Enable(True)\n labelLbl.Enable(True)\n labelCtrl.Enable(True)\n boxDisable()\n sel = listBoxCtrl.GetSelection() + 1\n self.oldSel=sel\n item = ['', []]\n self.groups.insert(sel,item)\n listBoxCtrl.Set([n[0] for n in self.groups])\n listBoxCtrl.SetSelection(sel)\n labelCtrl2.ChangeValue('')\n setValue(item)\n labelCtrl.SetFocus()\n btnApp.Enable(False)\n btnDEL.Enable(True)\n evt.Skip()\n btnApp.Bind(wx.EVT_BUTTON, OnButtonAppend)\n\n def OnLabelChange(evt):\n sel = self.oldSel\n if self.groups[sel][1]<>[]:\n sel2 = self.oldSel2\n label = labelCtrl2.GetValue().strip()\n self.groups[sel][1][sel2]=label\n listBoxCtrl2.Set(self.groups[sel][1])\n listBoxCtrl2.SetSelection(sel2)\n validation()\n evt.Skip()\n labelCtrl2.Bind(wx.EVT_TEXT, OnLabelChange)\n\n def onClick2(evt):\n sel2 = listBoxCtrl2.GetSelection()\n if self.oldSel2 != sel2:\n item = listBoxCtrl2.GetStrings()[self.oldSel2]\n if validateEmailAddr(item):\n label = listBoxCtrl2.GetStringSelection()\n labelCtrl2.ChangeValue(label)\n self.oldSel2=sel2\n listBoxCtrl2.SetSelection(self.oldSel2)\n listBoxCtrl2.SetFocus()\n evt.Skip()\n listBoxCtrl2.Bind(wx.EVT_LISTBOX, onClick2)\n\n def onButtonUp2(evt):\n sel = self.oldSel\n newSel,self.groups[sel][1]=Move(self.groups[sel][1],listBoxCtrl2.GetSelection(),-1)\n listBoxCtrl2.Set(self.groups[sel][1])\n listBoxCtrl2.SetSelection(newSel)\n self.oldSel2 = newSel\n evt.Skip()\n btnUP2.Bind(wx.EVT_BUTTON, onButtonUp2)\n\n def onButtonDown2(evt):\n sel = self.oldSel\n newSel,self.groups[sel][1]=Move(self.groups[sel][1],listBoxCtrl2.GetSelection(),1)\n listBoxCtrl2.Set(self.groups[sel][1])\n listBoxCtrl2.SetSelection(newSel)\n self.oldSel2 = newSel\n evt.Skip()\n btnDOWN2.Bind(wx.EVT_BUTTON, onButtonDown2)\n\n def onButtonDelete2(evt):\n sel = self.oldSel\n sel2 = listBoxCtrl2.GetSelection()\n lngth=len(self.groups[sel][1])\n if lngth==2:\n btnUP2.Enable(False)\n btnDOWN2.Enable(False)\n if lngth == 1:\n labelCtrl2.ChangeValue('')\n self.groups[sel][1] = []\n listBoxCtrl2.Set([])\n listBoxCtrl2.SetStringSelection('')\n btn1.Enable(False)\n btnDEL2.Enable(False)\n btnApp2.Enable(True)\n evt.Skip()\n return\n elif sel2 == lngth - 1:\n sel2 = 0\n self.oldSel2 = sel2\n tmp = self.groups[sel][1].pop(listBoxCtrl2.GetSelection())\n listBoxCtrl2.Set(self.groups[sel][1])\n listBoxCtrl2.SetSelection(sel2)\n item = self.groups[sel][1][sel2]\n labelCtrl2.ChangeValue(item)\n validation()\n evt.Skip()\n btnDEL2.Bind(wx.EVT_BUTTON, onButtonDelete2)\n\n def OnButtonAppend2(evt):\n if len(self.groups[self.oldSel][1]) == 1:\n btnUP2.Enable(True)\n btnDOWN2.Enable(True)\n labelLbl2.Enable(True)\n labelCtrl2.Enable(True)\n addressesLbl.Enable(True)\n listBoxCtrl2.Enable(True)\n sel = listBoxCtrl2.GetSelection() + 1\n self.oldSel2=sel\n self.groups[self.oldSel][1].insert(sel,'')\n listBoxCtrl2.Set(self.groups[self.oldSel][1])\n listBoxCtrl2.SetSelection(sel)\n labelCtrl2.SetValue('')\n labelCtrl2.SetFocus()\n btnApp2.Enable(False)\n btnDEL2.Enable(True)\n evt.Skip()\n btnApp2.Bind(wx.EVT_BUTTON, OnButtonAppend2)\n#===============================================================================\n\nclass observViewerDialog(wx.MiniFrame):\n def __init__(self, parent, plugin, observThreads):\n wx.MiniFrame.__init__(\n self, parent, -1,\n style=wx.CAPTION|wx.RESIZE_BORDER, name=\"Observations viewer/manager\"\n )\n self.SetBackgroundColour(wx.NullColour)\n self.observThreads = observThreads\n self.plugin = plugin\n\n def ShowObservViewerDialog(self):\n text = self.plugin.text\n self.SetTitle(text.viewerTitle)\n mainSizer = wx.BoxSizer(wx.VERTICAL)\n mainSizer.Add(\n wx.StaticText(self, -1, text.listhead),\n 0,wx.TOP|wx.LEFT|wx.RIGHT,10\n )\n\n centralSizer = wx.GridBagSizer(10, 10)\n centralSizer.AddGrowableRow(0)\n centralSizer.AddGrowableCol(3)\n observListCtrl = wx.ListCtrl(self, -1, style=wx.LC_REPORT | wx.VSCROLL | wx.HSCROLL)\n for i, colLabel in enumerate(text.colLabels):\n observListCtrl.InsertColumn(\n i,\n colLabel,\n wx.LIST_FORMAT_RIGHT if (i==1 or i==2) else wx.LIST_FORMAT_LEFT\n )\n observListCtrl.InsertStringItem(0, text.colLabels[0])\n observListCtrl.SetStringItem(0, 2, time.strftime(\"%c\"))\n size = 0\n for i in range(5):\n observListCtrl.SetColumnWidth(i, wx.LIST_AUTOSIZE_USEHEADER)\n size += observListCtrl.GetColumnWidth(i)\n observListCtrl.SetMinSize((size, -1))\n centralSizer.Add(observListCtrl, (0,0),(1,5), flag = wx.EXPAND)\n #buttons\n abortButton = wx.Button(self, -1, text.buttons[0])\n abortAllButton = wx.Button(self, -1, text.buttons[1])\n refreshButton = wx.Button(self, -1, text.buttons[2])\n closeButton = wx.Button(self, -1, text.buttons[3])\n centralSizer.Add(abortButton,(1,0), flag = wx.ALIGN_CENTER_HORIZONTAL|wx.BOTTOM, border = 10)\n centralSizer.Add(abortAllButton,(1,1), flag = wx.ALIGN_CENTER_HORIZONTAL)\n centralSizer.Add(refreshButton,(1,2), flag = wx.ALIGN_LEFT)\n centralSizer.Add(closeButton,(1,4), flag = wx.ALIGN_RIGHT)\n\n def FillListCtrl (event=None):\n observListCtrl.DeleteAllItems()\n row = 0\n for i, item in enumerate(self.observThreads):\n ot = self.observThreads[item]\n if ot.isAlive() and not ot.isAborted():\n observListCtrl.InsertStringItem(row, ot.observName)\n observListCtrl.SetStringItem(row, 1, str(ot.setup[1]))\n timestamp = time.strftime(\"%c\", time.localtime(ot.lastCheck)) if ot.lastCheck!=0 else ''\n observListCtrl.SetStringItem(row, 2, timestamp)\n observListCtrl.SetStringItem(row, 3, ot.setup[3])\n observListCtrl.SetStringItem(row, 4, ot.setup[12])\n row += 1\n ListSelection()\n\n def OnAbortButton(event):\n item = observListCtrl.GetFirstSelected()\n while item != -1:\n name = observListCtrl.GetItemText(item)\n ot = self.observThreads[name]\n if ot.isAlive():\n ot.AbortObservation()\n time.sleep(0.25)\n item = observListCtrl.GetNextSelected(item)\n FillListCtrl()\n event.Skip()\n\n def OnAbortAllButton(event):\n thrds = list(enumerate(self.observThreads))\n thrds.reverse()\n for i, name in thrds:\n ot = self.observThreads[name]\n ot.AbortObservation()\n time.sleep(0.25)\n FillListCtrl()\n self.Update()\n event.Skip()\n\n def OnCloseButton(event):\n self.Destroy()\n event.Skip()\n\n def ListSelection(event=None):\n flag = observListCtrl.GetFirstSelected() != -1\n abortButton.Enable(flag)\n if event:\n event.Skip()\n\n def OnSize(event):\n observListCtrl.SetColumnWidth(6, wx.LIST_AUTOSIZE_USEHEADER)\n event.Skip()\n\n FillListCtrl()\n self.SetMinSize((size+52,178))\n self.SetSize((size+52,178))\n abortButton.Bind(wx.EVT_BUTTON, OnAbortButton)\n abortAllButton.Bind(wx.EVT_BUTTON, OnAbortAllButton)\n refreshButton.Bind(wx.EVT_BUTTON, FillListCtrl)\n closeButton.Bind(wx.EVT_BUTTON, OnCloseButton)\n observListCtrl.Bind(wx.EVT_LIST_ITEM_SELECTED, ListSelection)\n observListCtrl.Bind(wx.EVT_LIST_ITEM_DESELECTED, ListSelection)\n self.Bind(wx.EVT_SIZE, OnSize)\n mainSizer.Add(centralSizer, 1,wx.EXPAND|wx.LEFT|wx.RIGHT,10)\n self.SetSizer(mainSizer)\n mainSizer.Layout()\n self.Show()\n#===============================================================================\n\nclass SendMailThread(Thread):\n def __init__(\n self,\n plugin,\n sbjct,\n From,\n To,\n Copy,\n Txt,\n Append,\n toName,\n references,\n messageID\n ):\n Thread.__init__(self, name=\"SendMailThread\" )\n self.plugin=plugin\n self.passSMTP = self.plugin.passSMTP\n self.sbjct = sbjct\n self.From = From\n self.To = To\n self.Copy = Copy\n self.Txt = Txt\n self.Append = Append\n self.toName = toName\n self.references = references\n self.messageID = messageID\n\n def run(self):\n sbjct = self.sbjct\n sbjct = eg.ParseString(sbjct)\n From = self.From\n To = self.To\n To = eg.ParseString(To)\n Copy = self.Copy\n Txt = self.Txt\n Txt = eg.ParseString(Txt)\n text = self.plugin.text\n Append = self.Append\n Append = eg.ParseString(Append)\n toName = self.toName\n toName = eg.ParseString(toName)\n choices = [item[0] for item in self.plugin.texts]\n if Append in choices:\n indx = choices.index(Append)\n Append = self.plugin.texts[indx][1]\n else:\n Append = None\n From = From.split(' - ')[-1]\n indx = [item[0] for item in self.plugin.configs].index(From)\n account = self.plugin.configs[indx]\n try:\n indx = [item[0] for item in self.plugin.servers].index(account[8])\n except:\n eg.PrintError(text.error5 % (account[8], self.plugin.servers[0][0]))\n indx = 0\n server = self.plugin.servers[indx]\n choices = [item[0] for item in self.plugin.groups]\n if Copy in choices:\n indx = choices.index(Copy)\n Copy = self.plugin.groups[indx][1]\n else:\n Copy = None\n#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n header_charset = 'UTF-8'\n body = Txt\n if Append is not None:\n body += '\\n----====###====----\\n'+Append\n for body_charset in 'US-ASCII', 'UTF-8':\n try:\n body.encode(body_charset)\n except UnicodeError:\n pass\n else:\n break\n sender_name = str(Header(unicode(account[2]), header_charset))\n recipient_name = str(Header(unicode(toName), header_charset))\n msg = MIMEText(body.encode(body_charset), 'plain', body_charset)\n msg['From'] = formataddr((sender_name, account[3]))\n msg['To'] = formataddr((recipient_name, To))\n if Copy is not None:\n msg['Cc'] = ','.join(Copy)\n msg['Subject'] = Header(unicode(sbjct), header_charset)\n msg[\"User-agent\"]= \"EventGhost %s\" % eg.Version.string\n if account[4] != '':\n msg[\"Reply-to\"]= formataddr((sender_name,account[4]))\n #msg[\"Date\"] = formatdate() #return: Wed, 03 Dec 2008 12:17:35 -0000\n msg[\"Date\"] = formatdate(None, True) #return: Wed, 03 Dec 2008 13:17:35 +0100\n if self.messageID is not None:\n msg['In-Reply-To'] = self.messageID\n if self.references is None:\n msg['References'] = self.messageID+u'\\r\\n'\n else:\n msg['References'] = self.references+self.messageID+u'\\r\\n'\n case = server[3] #secure connection ?\n try:\n if case < 3:\n smtp = smtplib.SMTP(server[1],server[2])\n else:\n smtp = smtplib.SMTP_SSL(server[1],server[2])\n except:\n eg.PrintError(text.error6+' '+text.error7 % (server[1],server[2]))\n else:\n try:\n if server[4]: #secure authentication\n #smtp.debuglevel = 5\n capa = smtp.ehlo()\n if case == 1 and not 'STARTTLS' in capa[-1].upper():\n case = 0\n if case == 0 or case == 3:\n smtp.esmtp_features[\"auth\"] = \"LOGIN PLAIN\"\n else:\n smtp.starttls()\n smtp.ehlo()\n password = self.passSMTP.data[server[0]]\n smtp.login(server[5], password)\n if Copy is None:\n smtp.sendmail(account[3], To, msg.as_string())\n else:\n rcpnt = [To]\n rcpnt.extend(Copy)\n smtp.sendmail(account[3], rcpnt, msg.as_string())\n except:\n eg.PrintError(text.error6+' '+text.error8)\n else:\n From = formataddr((account[2], account[3]))\n eg.TriggerEvent('Sent', payload = '%s: %s' % (From, sbjct), prefix = 'E-mail')\n smtp.quit()\n#===============================================================================\n\nclass deleteEmail(Thread):\n def __init__(\n self,\n indx,\n sel,\n mode,\n parent\n ):\n self.indx = indx\n self.sel = sel\n self.mode = mode\n self.parent = parent\n Thread.__init__(self, name = 'DeleteEmail')\n\n def run(self):\n self.parent.RealizeAction(self.indx, self.sel, self.mode)\n#===============================================================================\n\nclass WorkThread(Thread):\n def __init__(\n self,\n plugin,\n setup,\n notifFrame,\n ):\n self.setup = setup\n Thread.__init__(self, name = self.setup[0].encode('unicode_escape')+'_W-Thread')\n self.plugin = plugin\n self.passINC = self.plugin.passINC\n self.configs = self.plugin.configs\n self.notifFrame = notifFrame\n self.runFlag = False\n self.abort = False\n self.refresh=False\n self.threadFlag = Event()\n self.delArgs = None\n self.text = self.plugin.text\n print self.text.observStarts % self.setup[0]\n\n def isRunning(self):\n return self.runFlag\n\n def DeleteAction(self, args):\n self.delArgs = args\n if not self.runFlag:\n self.threadFlag.set()\n\n def operate(self, refresh = False):\n self.refresh = refresh or self.refresh\n if not self.runFlag:\n self.threadFlag.set()\n\n def AbortObservation(self, close = False):\n self.abort = True\n self.close = close\n self.threadFlag.set()\n\n def run(self):\n while 1:\n if self.abort:\n break\n self.runFlag = True\n if self.delArgs is not None:\n self.delArgs[3].RealizeAction(self.delArgs[0], self.delArgs[1], self.delArgs[2])\n if self.delArgs[3].isCloseReq():\n self.delArgs[3].Close()\n else:\n self.delArgs[3].resDelFlag()\n self.delArgs = None\n val, shift = self.CheckEmails()\n if self.setup[6]: #Show notification Window\n self.notifFrame.SetNum(val)\n if val>0:\n if not self.notifFrame.IsShown():\n self.notifFrame.Show(True)\n else:\n self.notifFrame.Disappear()\n else:\n val, shift = self.CheckEmails()\n if self.setup[6]: #Show notification Window\n if val == 0:\n self.notifFrame.Disappear()\n elif shift or self.refresh:\n self.notifFrame.SetNum(val)\n if not self.notifFrame.IsShown():\n self.notifFrame.Show(True)\n if self.refresh:\n self.refresh = False\n else:\n if self.setup[7]: #Trigger event\n if val > 0 and shift:\n if self.setup[8]:\n eg.TriggerEvent(self.setup[3], payload = str(val), prefix = 'E-mail')\n else:\n eg.TriggerEvent(self.setup[3], prefix = 'E-mail')\n self.runFlag = False\n if self.abort:\n break\n if self.delArgs is None:\n self.threadFlag.clear()\n self.threadFlag.wait()\n self.notifFrame.Disappear(self.close)\n self.observName = self.setup[0]\n indx = [item[0] for item in self.plugin.tempData].index(self.observName)\n self.plugin.tempData[indx][1:]=[0,[],None,self.notifFrame]\n\n def CreateOneRecord(self, data, account, nbr, id):\n msg=myParser.parsestr(data)\n if msg.has_key('Message-Id'):\n messId = msg['Message-Id']\n else:\n messId = ParseAddress(msg['From'])\n tmpRec=[messId] #0\n tmpRec.append(ParseItem(msg['Subject'])) #1\n tmpRec.append(ParseAddress(msg['From'])) #2\n tmpRec.append(account) #3\n tmpRec.append(str(nbr)) #4\n tmpRec.append(id) #5\n return tmpRec\n\n def CheckEmails(self):\n accList=[n[0] for n in self.configs]\n accounts = []\n observName = self.setup[0]\n loop=0\n while 1:\n try:\n loop+=1\n indx = [item[0] for item in self.plugin.tempData].index(observName)\n break\n except:\n pass\n for i in range(len(accList)):\n for item in self.setup[2]:\n if item == accList[i]:\n accounts.append(i)\n nbr = 0\n if len(self.plugin.tempData[indx][2])>0:\n idList = [item[0] for item in self.plugin.tempData[indx][2]]\n else:\n idList = []\n count = 0\n tmpData =[]\n if self.setup[4] == 0: #non-filter mode\n for i in accounts:\n account = self.configs[i]\n SERVER = account[5]\n PORT = account[6]\n USER = account[7]\n PASSWORD = self.passINC.data[account[0]]\n USE_SSL = account[9] == 3\n if account[1] == 0: #POP\n try:\n if USE_SSL:\n mailbox = poplib.POP3_SSL(SERVER,PORT)\n else:\n mailbox = poplib.POP3(SERVER,PORT)\n except:\n eg.PrintError(self.text.error0+' '+self.text.error1 % (SERVER,PORT))\n else:\n #mailbox.set_debuglevel(5)\n try:\n mailbox.user(USER)\n mailbox.pass_(PASSWORD)\n #capa = mailbox._longcmd('CAPA')[1]\n #if 'STLS' in capa:\n # print 'STLS'\n # #mailbox._shortcmd('STLS')\n lst = mailbox.list()[1]\n cnt = len(lst)\n if cnt > 0:\n count += cnt\n MAXLINES = 0\n for msg in lst:\n id = msg.split(' ')[0]\n resp, data, octets = mailbox.top(id, MAXLINES)\n if resp != '+OK':\n resp, data, octets = mailbox.retr(id)\n data = \"\\n\".join(data)\n nbr += 1\n oneRec = self.CreateOneRecord(data, account[0], nbr, id)\n tmpData.append(oneRec)\n except poplib.error_proto, errmsg:\n eg.PrintError(self.text.error0+' '+str(errmsg))\n mailbox.quit()\n else: #IMAP\n try:\n if USE_SSL:\n mailbox = imaplib.IMAP4_SSL(SERVER, PORT)\n else:\n mailbox = imaplib.IMAP4(SERVER, PORT)\n except:\n eg.PrintError(self.text.error2+' '+self.text.error3 % (SERVER,PORT))\n else:\n try:\n mailbox.login(USER, PASSWORD)\n except:\n eg.PrintError(self.text.error2+' '+self.text.error4 % (USER, SERVER, PORT))\n else:\n typ, data = mailbox.select('INBOX') #Folder selection\n typ, data = mailbox.search(None, 'UNSEEN')\n if data[0]:\n lst = data[0].split()\n count += len(lst)\n for num in lst:\n typ, data = mailbox.fetch(num, '(RFC822.HEADER)')\n mailbox.store(num, \"-FLAGS\", '(\\Seen)') #Reset UNSEEN flag\n data = data[0][1]\n nbr += 1\n oneRec = self.CreateOneRecord(data, account[0], nbr, num)\n tmpData.append(oneRec)\n mailbox.logout()\n\n#-------------------------\n else: #filter mode\n def processEmail(mailbox, data, idList, account, count, id, tmpData):\n conds = [\"%s.find(%s)>-1\",\n \"not %s.find(%s)>-1\",\n \"%s==%s\",\n \"not %s==%s\",\n \"%s.startswith(%s)\",\n \"%s.endswith(%s)\"]\n msg = myParser.parsestr(data)\n parts = GetParts(msg)\n flag = False\n if self.setup[4] == 1: #filter AND mode\n i = 0\n while i < 6:\n what, cond, strng = self.setup[5][i]\n if what > 0 and not eval(conds[cond] % (('parts[what-1]'), 'strng')):\n break\n i += 1\n if i == 6:\n flag = True\n else: #filter OR mode\n i = 0\n while i < 6:\n what, cond, strng = self.setup[5][i]\n if what > 0 and eval(conds[cond] % (('parts[what-1]'), 'strng')):\n flag = True\n break\n i += 1\n if flag:\n if msg.has_key('Message-Id'):\n messId = msg['Message-Id']\n else:\n messId = parts[1]\n if self.setup[11]: #trigger event for each email ?\n if not messId in idList:\n itms = self.plugin.text.field_1[1:]\n suff = self.setup[12]\n if suff in itms:\n suff = itms.index(suff)\n suff = u\"%s.%s\" % (self.setup[12],parts[suff])\n if self.setup[13] > 0:\n eg.TriggerEvent(suff, payload = parts[self.setup[13]-1], prefix = 'E-mail')\n else:\n eg.TriggerEvent(suff, prefix = 'E-mail')\n if self.setup[14]: #~ delete\n if account[1] == 0: #POP\n resp = mailbox.dele(id)\n #if resp[:3]=='+OK':\n # print \"deleted !!!\"\n # notDeleted = False\n else:\n resp = mailbox.store(id, \"+FLAGS\", '(\\Deleted)')\n #if resp[0] =='OK':\n # resp = mailbox.expunge()\n # if resp[0] =='OK':\n # print \"deleted !!!\"\n count += 1\n #show notification window?\n if not self.setup[14]:\n tmpRec = [messId] #0 ID\n tmpRec.append(parts[0]) #1 Subject\n tmpRec.append(parts[1]) #2 From\n tmpRec.append(account[0]) #3\n tmpRec.append(str(count)) #4\n tmpRec.append(id) #5\n tmpData.append(tmpRec)\n return (count, tmpData)\n#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n for i in accounts:\n account = self.configs[i]\n SERVER = account[5]\n PORT = account[6]\n USER = account[7]\n PASSWORD = self.passINC.data[account[0]]\n USE_SSL = account[9] == 3\n if account[1] == 0: #POP\n try:\n if USE_SSL:\n mailbox = poplib.POP3_SSL(SERVER, PORT)\n else:\n mailbox = poplib.POP3(SERVER, PORT)\n except:\n eg.PrintError(self.text.error0+' '+self.text.error1 % (SERVER,PORT))\n else:\n try:\n mailbox.user(USER)\n mailbox.pass_(PASSWORD)\n lst = mailbox.list()[1]\n cnt = len(lst)\n if cnt > 0:\n for msg in lst:\n id = msg.split(' ')[0]\n resp, data, octets = mailbox.retr(id)\n data = \"\\n\".join(data)\n count, tmpData = processEmail(mailbox, data,idList, account, count, id, tmpData)\n except poplib.error_proto, errmsg:\n eg.PrintError(self.text.error0+' '+str(errmsg))\n mailbox.quit()\n#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n else: #IMAP\n try:\n if USE_SSL:\n mailbox = imaplib.IMAP4_SSL(SERVER, PORT)\n else:\n mailbox = imaplib.IMAP4(SERVER, PORT)\n except:\n eg.PrintError(self.text.error2+' '+self.text.error3 % (SERVER,PORT))\n else:\n try:\n mailbox.login(USER, PASSWORD)\n except:\n eg.PrintError(self.text.error2+' '+self.text.error4 % (USER, SERVER, PORT))\n else:\n typ, data = mailbox.select('INBOX') #Folder selection\n typ, data = mailbox.search(None, 'UNSEEN')\n if data[0]:\n lst = data[0].split()\n for id in lst:\n typ, data = mailbox.fetch(id, '(RFC822)')\n mailbox.store(id, \"-FLAGS\", '(\\Seen)') #Reset UNSEEN flag\n data = data[0][1]\n count, tmpData = processEmail(mailbox, data,idList, account, count, id, tmpData)\n resp = mailbox.expunge()\n mailbox.logout()\n countOld = self.plugin.tempData[indx][1]\n shift = count != countOld\n countOld = count\n self.plugin.tempData[indx][2] = tmpData\n self.plugin.tempData[indx][1] = count\n return count, shift\n#===============================================================================\n\nclass ObservationThread(Thread):\n def __init__(\n self,\n setup,\n plugin,\n notifFrame,\n ):\n self.setup = setup\n Thread.__init__(self, name=self.setup[0].encode('unicode_escape')+'_O-Thread')\n self.plugin = plugin\n self.notifFrame = notifFrame\n self.observName = setup[0]\n self.abort = False\n self.lastCheck = 0\n self.threadFlag = Event()\n self.firstRun = True\n\n def isAborted(self):\n return self.abort\n\n def run(self):\n while 1:\n if self.firstRun:\n self.firstRun = False\n while True:\n try:\n if self.plugin.tempData[indx][3] is not None:\n wt = self.plugin.tempData[indx][3]\n if wt.isAlive():\n #print \"WAITING\"\n wt.AbortObservation()\n self.threadFlag.wait(1)\n self.threadFlag.clear()\n except:\n self.plugin.observThreads[self.setup[0]] = self #update dictionary\n indx = [item[0] for item in self.plugin.tempData].index(self.observName)\n self.wt = WorkThread(plugin = self.plugin, setup = self.setup, notifFrame = self.notifFrame)\n self.plugin.tempData[indx][3] = self.wt\n self.wt.start()\n break\n else:\n if self.abort:\n break\n self.lastCheck = time.time()\n self.wt.operate()\n self.threadFlag.wait(60*self.setup[1])\n self.threadFlag.clear()\n\n def AbortObservation(self, close=False):\n self.wt.AbortObservation(close)\n self.abort = True\n self.threadFlag.set()\n#===============================================================================\n\nclass AbortAllObservations(eg.ActionClass):\n def __call__(self):\n self.plugin.AbortAllObservations()\n#===============================================================================\n\nclass AbortObservation(eg.ActionClass):\n def __call__(self, observName=''):\n self.plugin.AbortObservation(observName)\n\n def Configure(self, observName=''):\n text=self.text\n panel = eg.ConfigPanel(self)\n nameLbl=wx.StaticText(panel, -1, text.nameObs)\n nameCtrl=wx.TextCtrl(panel,-1,observName)\n mainSizer = wx.BoxSizer(wx.VERTICAL)\n mainSizer.Add(nameLbl,0)\n mainSizer.Add(nameCtrl,0,wx.EXPAND)\n panel.sizer.Add(mainSizer)\n panel.sizer.Layout()\n\n # re-assign the test button\n def OnTestButton(event):\n self.plugin.AbortObservation(nameCtrl.GetValue())\n panel.dialog.buttonRow.testButton.SetLabel(text.abortNow)\n panel.dialog.buttonRow.testButton.SetToolTipString(text.tip)\n panel.dialog.buttonRow.testButton.Bind(wx.EVT_BUTTON, OnTestButton)\n\n while panel.Affirmed():\n panel.SetResult(\n nameCtrl.GetValue(),\n )\n\n class text:\n nameObs = 'Observation name:'\n abortNow = 'Abort now !'\n tip = 'Abort observation now'\n#===============================================================================\n\nclass StartObservation(eg.ActionClass):\n\n def startObserv(self, stp):\n observName = stp[0]\n data = [item[0] for item in self.plugin.tempData]\n if observName in data:\n indx = data.index(observName)\n self.notifFrame = self.plugin.tempData[indx][4]\n else:\n self.notifFrame = NotifFrame(None)\n self.event = CreateEvent(None, 0, 0, None)\n wx.CallAfter(self.notifFrame.ShowNotifFrame,\n plugin = self.plugin,\n stp = stp,\n event = self.event\n )\n eg.actionThread.WaitOnEvent(self.event)\n self.plugin.StartObservation(stp, self.notifFrame)\n\n def __call__(self, stp):\n #stp\n accounts=[]\n accList = [item[0] for item in self.plugin.configs]\n for i in range(len(accList)):\n for item in stp[2]:\n if item == accList[i]:\n accounts.append(i)\n if len(accounts) > 0:\n self.startObserv(stp)\n else:\n eg.PrintError(self.text.warning % stp[2])\n\n def GetLabel(self, stp):\n res1 = stp[0]\n return res1\n\n def Configure(self, stp = []):\n\n#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n self.flag2=True\n def validation():\n if self.flag2:\n return\n while 1:\n flag = False\n if nameCtrl.GetValue() == \"\":\n break\n lng = len(accountCtrl.GetStrings())\n if lng == 0:\n break\n indx = 0\n while indx < lng:\n if accountCtrl.IsChecked(indx):\n break\n indx += 1\n if indx == lng: # No one checkbox is checked ?\n break\n\n if not eventCtrl.GetValue() and not event2Ctrl.GetValue() and not messageCtrl.GetValue():\n break\n\n if eventCtrl.GetValue():\n if evtNameCtrl.GetValue() == '':\n break\n\n if event2Ctrl.GetValue():\n if evtName2Ctrl.GetValue() == '':\n break\n\n if not rb0.GetValue():\n indx = 0\n sum = 0\n while indx < 6:\n wnd0 = wx.FindWindowById(indx+100)\n if wnd0.GetSelection() > 0:\n wnd1 = wx.FindWindowById(indx+200)\n wnd2 = wx.FindWindowById(indx+300)\n if wnd1.GetSelection() == -1:\n break\n if wnd2.GetValue() == '':\n break\n else:\n sum += 1\n indx += 1\n if indx < 6 or sum == 6:\n break\n #All is OK !\n flag = True\n break\n panel.dialog.buttonRow.applyButton.Enable(flag)\n panel.dialog.buttonRow.okButton.Enable(flag)\n#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\n def onFilter(evt):\n if self.flag2:\n return\n id = evt.GetId()\n if id < 200:\n ctrl_1=wx.FindWindowById(id)\n indx=ctrl_1.GetSelection()\n flag = indx > 0\n ctrl_2=wx.FindWindowById(id+100)\n ctrl_3=wx.FindWindowById(id+200)\n ctrl_2.Enable(flag)\n ctrl_3.Enable(flag)\n if not flag:\n ctrl_2.SetSelection(-1)\n ctrl_3.ChangeValue('')\n choicLen = len(ctrl_2.GetStrings())\n if choicLen == 2 and indx !=3:\n ctrl_2.Clear()\n ctrl_2.AppendItems(strings = text.field_2)\n elif choicLen == 6 and indx == 3:\n ctrl_2.Clear()\n ctrl_2.AppendItems(strings = text.field_2[:2])\n evt.Skip()\n validation()\n#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n if stp == []:\n self.stp = [\n '',2,[],'',0,\n [[-1,-1,''],[-1,-1,''],[-1,-1,''],[-1,-1,''],[-1,-1,''],[-1,-1,'']],\n False, True, 0, (255,255,255), (0,0,0), False,'',0, False\n ]\n else:\n self.stp = cpy(stp)\n\n text=self.text\n panel = eg.ConfigPanel(self)\n nameLbl=wx.StaticText(panel, -1, text.nameObs)\n nameCtrl=wx.TextCtrl(panel,-1,self.stp[0])\n intervalLbl_1=wx.StaticText(panel, -1, text.interval_1)\n intervalCtrl = eg.SpinIntCtrl(\n panel,\n -1,\n value = self.stp[1],\n min=1,\n max=999,\n )\n intervalLbl_2=wx.StaticText(panel, -1, text.interval_2)\n accountLbl=wx.StaticText(panel, -1, text.accounts)\n choices=[n[0] for n in self.plugin.configs]\n accountCtrl = wx.CheckListBox(\n panel,\n -1,\n choices = choices,\n size=((-1,80)),\n )\n checked = self.stp[2]\n for i in range(len(choices)):\n while 1:\n for x in checked:\n if x == choices[i]:\n accountCtrl.Check(i,True)\n break\n break\n\n rb0 = panel.RadioButton(self.stp[4]==0,text.radio_buttons[0], style=wx.RB_GROUP)\n rb1 = panel.RadioButton(self.stp[4]==1,text.radio_buttons[1])\n rb2 = panel.RadioButton(self.stp[4]==2,text.radio_buttons[2])\n messageCtrl = wx.CheckBox(panel, label = text.message)\n messageCtrl.SetValue(self.stp[6])\n messageCtrl.Enable(not self.stp[14])\n messageCtrl.SetToolTipString(text.tip0)\n eventCtrl = wx.CheckBox(panel, label = text.totalEvent)\n eventCtrl.SetToolTipString(text.tip4)\n event2Ctrl = wx.CheckBox(panel, label = text.emailEvent)\n event2Ctrl.SetToolTipString(text.tip3)\n event2Ctrl.SetValue(self.stp[11])\n eventCtrl.SetValue(self.stp[7])\n eventCtrl.Enable(not self.stp[14])\n event2Ctrl.Enable(False)\n evtNameLbl=wx.StaticText(panel, -1, text.evtName)\n evtNameCtrl=wx.TextCtrl(panel,-1,self.stp[3])\n #evtName2Ctrl=wx.TextCtrl(panel,-1,self.stp[12])\n evtName2Ctrl = wx.ComboBox(\n panel,\n -1,\n choices = self.plugin.text.field_1[1:],\n style = wx.CB_DROPDOWN\n )\n evtName2Ctrl.SetValue(self.stp[12])\n payloadLbl=wx.StaticText(panel, -1, text.payload)\n payloadCtrl = wx.Choice(panel, -1, choices =text.totalPayload)\n payload2Ctrl = wx.Choice(panel, -1, choices=self.plugin.text.field_1)\n payloadCtrl.SetSelection(self.stp[8])\n payload2Ctrl.SetSelection(self.stp[13])\n deleteCtrl = wx.CheckBox(panel, label = text.delete)\n deleteCtrl.SetValue(self.stp[14])\n deleteCtrl.SetToolTipString(text.tip1)\n filterSizer = wx.FlexGridSizer(4,3,0,0)\n for n in range(6):\n fieldCtrl_1 = wx.Choice(panel,id=100+n,choices=self.plugin.text.field_1)\n fieldCtrl_1.Bind(wx.EVT_CHOICE,onFilter)\n indx0 = self.stp[5][n][0]\n fieldCtrl_1.SetSelection(indx0)\n if indx0 == -1:\n fieldCtrl_1.Enable(False)\n fieldCtrl_2 = wx.Choice(panel,id=200+n,choices=text.field_2)\n fieldCtrl_2.Bind(wx.EVT_CHOICE,onFilter)\n indx1 = self.stp[5][n][1]\n fieldCtrl_2.SetSelection(indx1)\n fieldCtrl_3 = wx.TextCtrl(panel,300+n,self.stp[5][n][2])\n fieldCtrl_3.Bind(wx.EVT_TEXT,onFilter)\n filterSizer.Add(fieldCtrl_1)\n filterSizer.Add(fieldCtrl_2)\n filterSizer.Add(fieldCtrl_3)\n if indx0 < 1:\n fieldCtrl_2.Enable(False)\n fieldCtrl_3.Enable(False)\n horizSizer = wx.BoxSizer(wx.HORIZONTAL)\n leftSizer = wx.BoxSizer(wx.VERTICAL)\n rightSizer = wx.BoxSizer(wx.VERTICAL)\n rightSizer.Add(rb0,0,wx.TOP,0)\n rightSizer.Add(rb1,0,wx.TOP,2)\n rightSizer.Add(rb2,0,wx.TOP,2)\n rightSizer.Add(filterSizer,0,wx.EXPAND|wx.TOP,7)\n intervalSizer = wx.BoxSizer(wx.HORIZONTAL)\n horizSizer.Add(leftSizer,0,wx.EXPAND,wx.TOP,0)\n horizSizer.Add(rightSizer,0,wx.LEFT|wx.EXPAND,16)\n leftSizer.Add(nameLbl,0,wx.TOP,0)\n leftSizer.Add(nameCtrl,0,wx.EXPAND)\n intervalSizer.Add(intervalLbl_1,0,wx.TOP,4)\n intervalSizer.Add(intervalCtrl,0,wx.LEFT|wx.RIGHT,4)\n intervalSizer.Add(intervalLbl_2,0,wx.TOP,4)\n leftSizer.Add(intervalSizer,0,wx.EXPAND|wx.TOP,15)\n leftSizer.Add(accountLbl,0,wx.TOP,11) #13\n leftSizer.Add(accountCtrl,0,wx.EXPAND)\n panel.sizer.Add(horizSizer)\n bottomSizer = wx.GridBagSizer(2,10)\n bottomSizer.Add(evtNameLbl,(0,1),wx.DefaultSpan)\n bottomSizer.Add(payloadLbl,(0,2),wx.DefaultSpan)\n bottomSizer.Add(event2Ctrl,(1,0),wx.DefaultSpan,wx.TOP,4)\n bottomSizer.Add(evtName2Ctrl,(1,1),wx.DefaultSpan,wx.EXPAND)\n bottomSizer.Add(payload2Ctrl,(1,2),wx.DefaultSpan,wx.EXPAND)\n bottomSizer.Add(deleteCtrl,(1,3),wx.DefaultSpan,wx.TOP|wx.ALIGN_RIGHT,4)\n bottomSizer.Add(eventCtrl,(2,0),wx.DefaultSpan,wx.TOP,10)\n bottomSizer.Add(evtNameCtrl,(2,1),wx.DefaultSpan,wx.TOP|wx.EXPAND,6)\n bottomSizer.Add(payloadCtrl,(2,2),wx.DefaultSpan,wx.TOP|wx.EXPAND,6)\n bottomSizer.Add(messageCtrl,(3,0),wx.DefaultSpan,wx.TOP,16)\n labelBck = wx.StaticText(panel, -1, text.backCol)\n labelFore = wx.StaticText(panel, -1, text.forCol)\n backgroundColourButton = wx.ColourPickerCtrl(panel)\n backgroundColourButton.SetColour(self.stp[9])\n foregroundColourButton = wx.ColourPickerCtrl(panel)\n foregroundColourButton.SetColour(self.stp[10])\n colourSizer = wx.GridBagSizer(3,3)\n colourSizer.AddGrowableCol(2)\n colourSizer.Add(labelBck,(0,0),wx.DefaultSpan,wx.TOP,4)\n colourSizer.Add(backgroundColourButton,(0,1))\n colourSizer.Add(labelFore,(0,3),wx.DefaultSpan,wx.TOP,4)\n colourSizer.Add(foregroundColourButton,(0,4))\n bottomSizer.Add(colourSizer,(3,1),(1,3),wx.TOP|wx.EXPAND,12)\n panel.sizer.Add(bottomSizer,0,wx.EXPAND|wx.TOP,12)\n panel.sizer.Layout()\n self.flag2=False\n\n def OnBackgroundColourButton(event):\n self.stp[9] = event.GetColour()\n backgroundColourButton.Bind(wx.EVT_COLOURPICKER_CHANGED, OnBackgroundColourButton)\n\n def OnForegroundColourButton(event):\n self.stp[10] = event.GetColour()\n foregroundColourButton.Bind(wx.EVT_COLOURPICKER_CHANGED, OnForegroundColourButton)\n\n def EnableEventCtrl():\n flag = deleteCtrl.GetValue()\n eventCtrl.Enable(not flag)\n if flag:\n eventCtrl.SetValue(False)\n evtNameCtrl.Enable(False)\n payloadCtrl.Enable(False)\n evtNameCtrl.ChangeValue('')\n payloadCtrl.SetSelection(0)\n\n def EnableEvent2Ctrl():\n if rb0.GetValue():\n event2Ctrl.SetValue(False)\n event2Ctrl.Enable(False)\n else:\n event2Ctrl.Enable(True)\n onEvent2Ctrl()\n EnableEventCtrl()\n\n def onRadioBtns(evt=None):\n if self.flag2:\n return\n if rb0.GetValue():\n mode = 0\n for indx in range(6):\n ctrl_1=wx.FindWindowById(indx+100)\n ctrl_2=wx.FindWindowById(indx+200)\n ctrl_3=wx.FindWindowById(indx+300)\n ctrl_1.Enable(False)\n ctrl_2.Enable(False)\n ctrl_3.Enable(False)\n ctrl_1.SetSelection(-1)\n ctrl_2.SetSelection(-1)\n ctrl_3.ChangeValue('')\n else:\n for indx in range(6):\n ctrl_1=wx.FindWindowById(indx+100)\n if not ctrl_1.IsEnabled():\n ctrl_1.SetSelection(0)\n ctrl_1.Enable(True)\n if rb1.GetValue():\n mode = 1\n else:\n mode = 2\n self.stp[4] = mode\n if evt:\n evt.Skip()\n EnableEvent2Ctrl()\n validation()\n rb0.Bind(wx.EVT_RADIOBUTTON, onRadioBtns)\n rb1.Bind(wx.EVT_RADIOBUTTON, onRadioBtns)\n rb2.Bind(wx.EVT_RADIOBUTTON, onRadioBtns)\n\n def onEvent2Ctrl(evt = None):\n flag = event2Ctrl.GetValue()\n evtName2Ctrl.Enable(flag)\n payload2Ctrl.Enable(flag)\n deleteCtrl.Enable(flag)\n if not flag:\n payload2Ctrl.SetSelection(0)\n deleteCtrl.SetValue(False)\n #evtName2Ctrl.ChangeValue('')\n evtName2Ctrl.SetValue('')\n self.stp[12] = ''\n self.stp[11] = flag\n if evt:\n evt.Skip()\n validation()\n event2Ctrl.Bind(wx.EVT_CHECKBOX, onEvent2Ctrl)\n\n def onDeleteCtrl(evt = None):\n flag = deleteCtrl.GetValue()\n messageCtrl.Enable(not flag)\n if flag:\n messageCtrl.SetValue(False)\n onMessageCtrl()\n EnableEventCtrl()\n evt.Skip()\n validation()\n deleteCtrl.Bind(wx.EVT_CHECKBOX, onDeleteCtrl)\n\n def onEventCtrl(evt = None):\n flag = eventCtrl.GetValue()\n evtNameCtrl.Enable(flag)\n payloadCtrl.Enable(flag)\n if not flag:\n #evtNameCtrl.ChangeValue('')\n evtNameCtrl.SetValue('')\n self.stp[3] = ''\n if evt:\n evt.Skip()\n validation()\n eventCtrl.Bind(wx.EVT_CHECKBOX, onEventCtrl)\n\n def onNameCtrl(evt):\n self.stp[0] = nameCtrl.GetValue()\n evt.Skip()\n validation()\n nameCtrl.Bind(wx.EVT_TEXT, onNameCtrl)\n\n def onEvtNameCtrl(evt):\n evt.Skip()\n validation()\n evtNameCtrl.Bind(wx.EVT_TEXT, onEvtNameCtrl)\n\n def onEvtName2Ctrl(evt):\n evt.Skip()\n validation()\n evtName2Ctrl.Bind(wx.EVT_TEXT, onEvtName2Ctrl)\n evtName2Ctrl.Bind(wx.EVT_COMBOBOX, onEvtName2Ctrl)\n\n def onMessageCtrl(evt=None):\n self.stp[6] = messageCtrl.GetValue()\n flag = self.stp[6]\n\n labelBck.Enable(flag)\n labelFore.Enable(flag)\n backgroundColourButton.Enable(flag)\n foregroundColourButton.Enable(flag)\n if evt:\n evt.Skip()\n validation()\n onMessageCtrl()\n messageCtrl.Bind(wx.EVT_CHECKBOX, onMessageCtrl)\n\n def onCheckListBox(evt):\n index = evt.GetSelection()\n evt.Skip()\n validation()\n accountCtrl.SetSelection(index) # so that (un)checking also selects (moves the highlight)\n accountCtrl.Bind(wx.EVT_CHECKLISTBOX, onCheckListBox)\n\n def UpdateConfig():\n choices = accountCtrl.GetStrings()\n tmpList=[]\n for indx in range(len(choices)):\n if accountCtrl.IsChecked(indx):\n tmpList.append(choices[indx])\n self.stp[2] = tmpList[:]\n tmpList=[]\n for indx in range(6):\n ctrl_0 = wx.FindWindowById(indx+100)\n indx0 = ctrl_0.GetSelection()\n ctrl_1 = wx.FindWindowById(indx+200)\n indx1 = ctrl_1.GetSelection()\n val2=wx.FindWindowById(indx+300).GetValue()\n tmpList.append((indx0, indx1, val2))\n self.stp[5] = tmpList[:]\n self.stp[1] = intervalCtrl.GetValue()\n self.stp[3] = evtNameCtrl.GetValue()\n self.stp[7] = eventCtrl.GetValue()\n self.stp[8] = payloadCtrl.GetSelection()\n self.stp[12] = evtName2Ctrl.GetValue()\n self.stp[13] = payload2Ctrl.GetSelection()\n self.stp[14] = deleteCtrl.GetValue()\n\n # re-assign the test button\n def OnTestButton(event):\n UpdateConfig()\n self.startObserv(self.stp)\n panel.dialog.buttonRow.testButton.SetLabel(text.startNow)\n panel.dialog.buttonRow.testButton.SetToolTipString(text.tip2)\n panel.dialog.buttonRow.testButton.Bind(wx.EVT_BUTTON, OnTestButton)\n EnableEvent2Ctrl()\n\n while panel.Affirmed():\n UpdateConfig()\n panel.SetResult(\n self.stp,\n )\n\n class text:\n nameObs = 'Observation name:'\n accounts = 'Accounts to observation:'\n interval_1 = 'Interval:'\n interval_2 = 'minutes'\n field_2 = (\n 'contains',\n \"doesn't contain \",\n 'is',\n \"isn't\",\n 'starts with',\n 'ends with',\n )\n radio_buttons = (\n 'Global observation without filtering',\n 'Message match all of the following rules',\n 'Message match any of the following rules',\n )\n message = 'Show notification window'\n #colour = \"Colours ...\"\n totalEvent = 'Trigger total event'\n evtName = 'Event name:'\n tip0 = 'Show notification window with count of waiting e-mails'\n tip1 = 'After event triggering delete e-mail on server'\n tip2 = 'Start observation now'\n tip3 = 'Trigger event for each e-mail'\n tip4 = 'Trigger event in any change in the number of waiting messages'\n emailEvent = \"E-mail event\"\n totalEvent = 'Total event'\n payload = \"Payload:\"\n totalPayload = (\"None\", \"Count\")\n delete = \"Delete\"\n startNow = 'Start now !'\n backCol = 'Background colour:'\n forCol = 'Foreground colour:'\n warning = 'Was found no one account, corresponding to the list %s !'\n#===============================================================================\n\nclass SendEmail(eg.ActionClass):\n def __call__(\n self,\n sbjct = '',\n From = '',\n To = '',\n Copy = '',\n Txt = '',\n Append = '',\n toName = '',\n references = None,\n messageID = None\n ):\n smt=SendMailThread(\n self.plugin,\n sbjct,\n From,\n To,\n Copy,\n Txt,\n Append,\n toName,\n references,\n messageID\n )\n smt.start()\n\n def Configure(\n self,\n sbjct = '',\n From = '',\n To = '',\n Copy = '',\n Txt = '',\n Append = '',\n toName = ''\n ):\n panel = eg.ConfigPanel(self, resizable=True)\n subjectCtrl,fromCtrl,toCtrl,copyCtrl,outTextCtrl,textsCtrl,toNameCtrl, topSizer = SendCfg(\n self,\n panel,\n sbjct,\n From,\n To,\n Copy,\n Txt,\n Append,\n toName,\n self.text,\n self.plugin\n )\n panel.sizer.Add(topSizer,1,wx.EXPAND|wx.LEFT|wx.RIGHT,16)\n text = self.text\n # re-assign the test button\n def OnTestButton(event):\n t = SendMailThread(\n self.plugin,\n subjectCtrl.GetValue(),\n fromCtrl.GetStringSelection(),\n toCtrl.GetValue(),\n copyCtrl.GetStringSelection(),\n outTextCtrl.GetValue(),\n textsCtrl.GetValue(),\n toNameCtrl.GetValue(),\n None,\n None\n )\n t.start()\n panel.dialog.buttonRow.testButton.SetLabel(text.sendNow)\n panel.dialog.buttonRow.testButton.SetToolTipString(text.tip3)\n panel.dialog.buttonRow.testButton.Bind(wx.EVT_BUTTON, OnTestButton)\n\n def validation(event=None):\n flag = True\n if not validateEmailAddr(toCtrl.GetValue()):\n flag = False\n if subjectCtrl.GetValue()=='':\n flag = False\n panel.dialog.buttonRow.applyButton.Enable(flag)\n panel.dialog.buttonRow.okButton.Enable(flag)\n\n subjectCtrl.Bind(wx.EVT_TEXT, validation)\n toCtrl.Bind(wx.EVT_TEXT, validation)\n validation()\n panel.sizer.Layout()\n\n while panel.Affirmed():\n panel.SetResult(\n subjectCtrl.GetValue(),\n fromCtrl.GetStringSelection(),\n toCtrl.GetValue(),\n copyCtrl.GetStringSelection(),\n outTextCtrl.GetValue(),\n textsCtrl.GetValue(),\n toNameCtrl.GetValue()\n )\n\n class text:\n fromLabel = 'From:'\n toLabel = 'To:'\n copyLabel = 'Copy:'\n subjectLabel = 'Subject:'\n outText = \"Text:\"\n outTexts = \"Append:\"\n tip = 'Here can be expression as {eg.event.payload} too !'\n tip1 = \"Recipient's Name (not obligatory)\"\n tip2 = \"Recipient's Address (obligatory)\"\n tip3 = 'Send your e-mail now !'\n sendNow = 'Send now !'\n replyTitle = 'Reply'\n#===============================================================================\n\nclass SendMailDlg(wx.MiniFrame):\n def __init__(self, parent):\n wx.MiniFrame.__init__(\n self,\n parent,\n -1,\n '',\n size = (360, 270),\n style = wx.CAPTION|wx.RESIZE_BORDER,\n name = 'Send Email'\n )\n self.SetBackgroundColour(wx.NullColour)\n\n def ShowSendMailDlg(\n self,\n sbjct = '',\n From = '',\n To = '',\n Copy = '',\n Txt = '',\n Append = '',\n toName = '',\n text = SendEmail.text,\n plugin = None,\n references = None,\n messageID = None\n ):\n self.SetTitle(3*' '+text.replyTitle)\n panel = self\n subjectCtrl,fromCtrl,toCtrl,copyCtrl,outTextCtrl,textsCtrl,toNameCtrl,topSizer = SendCfg(\n self,\n panel,\n sbjct,\n From,\n To,\n Copy,\n Txt,\n Append,\n toName,\n text,\n plugin\n )\n sizer = wx.BoxSizer(wx.VERTICAL)\n self.SetSizer(sizer)\n sizer.Add((1,10))\n sizer.Add(topSizer,1,wx.EXPAND|wx.LEFT|wx.RIGHT,16)\n line = wx.StaticLine(self, -1, size=(20,-1),pos = (200,0), style=wx.LI_HORIZONTAL)\n btn1 = wx.Button(self, wx.ID_OK)\n btn1.SetLabel(text.sendNow)\n btn1.Enable(False)\n btn1.SetDefault()\n btn2 = wx.Button(self, wx.ID_CANCEL)\n btn2.SetLabel(plugin.text.cancel)\n btnsizer = wx.StdDialogButtonSizer()\n btnsizer.AddButton(btn1)\n btnsizer.AddButton(btn2)\n btnsizer.Realize()\n sizer.Add((1,5))\n sizer.Add(line, 0, wx.EXPAND|wx.ALIGN_CENTER|wx.TOP|wx.BOTTOM,5)\n sizer.Add(btnsizer, 0, wx.EXPAND|wx.RIGHT, 12)\n sizer.Add((1,5))\n\n def onSomeChange(evt):\n flag = True\n if not validateEmailAddr(toCtrl.GetValue()):\n flag = False\n if subjectCtrl.GetValue()=='':\n flag = False\n if outTextCtrl.GetValue()=='':\n flag = False\n btn1.Enable(flag)\n\n toCtrl.Bind(wx.EVT_TEXT,onSomeChange)\n outTextCtrl.Bind(wx.EVT_TEXT,onSomeChange)\n subjectCtrl.Bind(wx.EVT_TEXT,onSomeChange)\n\n def onClose(evt):\n self.MakeModal(False)\n self.Destroy()\n self.Bind(wx.EVT_CLOSE, onClose)\n\n def onCancel(evt):\n self.Close()\n btn2.Bind(wx.EVT_BUTTON,onCancel)\n\n def onSend(evt):\n t = SendMailThread(\n self.plugin,\n subjectCtrl.GetValue(),\n fromCtrl.GetStringSelection(),\n toCtrl.GetValue(),\n copyCtrl.GetStringSelection(),\n outTextCtrl.GetValue(),\n textsCtrl.GetValue(),\n toNameCtrl.GetValue(),\n references,\n messageID\n )\n t.start()\n self.Close()\n\n btn1.Bind(wx.EVT_BUTTON,onSend)\n sizer.Layout()\n sizer.Fit(self)\n size = self.GetSize()\n self.SetMinSize(size)\n self.MakeModal(True)\n self.Centre()\n self.Show()\n self.SetFocus()\n self.Raise()\n#===============================================================================\n\nACTIONS = (\n (StartObservation, 'StartObservation', 'Start observation', 'Start observation.', None),\n (AbortObservation, 'AbortObservation', 'Abort observation', 'Abort observation.', None),\n (AbortAllObservations, 'AbortAllObservations', 'Abort all observations', 'Abort all observations.', None),\n (SendEmail, 'SendEmail', 'Send e-mail', 'Send e-mail.', None),\n)\n#===============================================================================\n\nclass E_mail(eg.PluginClass):\n configs = []\n servers = []\n texts = []\n groups = []\n\n def __init__(\n self,\n ):\n self.AddActionsFromList(ACTIONS)\n self.observThreads = {}\n\n def __stop__(self):\n self.AbortAllObservations(close = True)\n\n def __close__(self):\n self.AbortAllObservations(close = True)\n\n def __start__(\n self,\n configs=[],\n servers=[],\n texts = [],\n groups = [],\n passINC = eg.Bunch(data={}),\n passSMTP = eg.Bunch(data={})\n ):\n self.observThreads = {}\n self.tempData = []\n self.passINC = passINC\n self.passSMTP = passSMTP\n self.servers=servers\n self.configs=configs\n del passINC\n del passSMTP\n self.texts = texts\n self.groups = groups\n\n def StartObservation(\n self,\n setup,\n notifFrame,\n ):\n observName = setup[0]\n if observName in self.observThreads:\n ot = self.observThreads[observName]\n if ot.isAlive():\n ot.AbortObservation()\n if not observName in [item[0] for item in self.tempData]:\n self.tempData.append([observName, 0, [], None, notifFrame]) #update temporary data store\n ot = ObservationThread(\n setup,\n self,\n notifFrame\n )\n ot.start()\n\n def AbortObservation(self, observName):\n if observName in self.observThreads:\n ot = self.observThreads[observName]\n ot.AbortObservation()\n\n def AbortAllObservations(self, close=False):\n thrds = list(enumerate(self.observThreads))\n thrds.reverse()\n for i, item in thrds:\n ot = self.observThreads[item]\n ot.AbortObservation(close)\n\n def Configure(\n self,\n configs=[],\n servers=[],\n texts = [],\n groups = [],\n passINC = eg.Bunch(data={}),\n passSMTP = eg.Bunch(data={})\n ):\n panel = eg.ConfigPanel(self)\n panel.cfgs = cpy(configs)\n panel.servers = cpy(servers)\n panel.txts = cpy(texts)\n panel.grps = cpy(groups)\n del configs\n del servers\n del texts\n del groups\n panel.passINC = {}\n panel.passSMTP = {}\n for i,item in list(enumerate(passINC.data)):\n panel.passINC[item]=passINC.data[item]\n for i,item in list(enumerate(passSMTP.data)):\n panel.passSMTP[item]=passSMTP.data[item]\n text = self.text\n panel.dialog.buttonRow.okButton.SetToolTipString(text.warning)\n\n def boxEnable(enable):\n choiceType.Enable(enable) #\n labelCtrl.Enable(enable)\n labelLbl.Enable(enable)\n userNameLbl.Enable(enable)\n userNameCtrl.Enable(enable)\n mailAddressLbl.Enable(enable)\n mailAddressCtrl.Enable(enable)\n replAddressLbl.Enable(enable)\n replAddressCtrl.Enable(enable)\n incServerLbl.Enable(enable)\n incServerCtrl.Enable(enable)\n incPortLbl.Enable(enable)\n incPortCtrl.Enable(enable)\n userLoginLbl.Enable(enable)\n userLoginCtrl.Enable(enable)\n userPasswordLbl.Enable(enable)\n userPasswordCtrl.Enable(enable)\n outServerLbl.Enable(enable)\n panel.outServerCtrl.Enable(enable)\n choiceSecureLbl.Enable(enable)\n choiceSecureCtrl.Enable(enable)\n useSecureCtrl.Enable(enable)\n outServerBtn.Enable(enable)\n\n def setValue(item):\n labelCtrl.ChangeValue(item[0])\n choiceType.SetSelection(item[1])\n userNameCtrl.SetValue(item[2])\n mailAddressCtrl.SetValue(item[3])\n replAddressCtrl.SetValue(item[4])\n incServerCtrl.SetValue(item[5])\n incPortCtrl.SetValue(item[6])\n userLoginCtrl.SetValue(item[7])\n panel.outServerCtrl.SetStringSelection(item[8])\n choiceSecureCtrl.SetSelection(item[9])\n useSecureCtrl.SetValue(item[10])\n if item[0] != '' and item[0] in panel.passINC:\n userPasswordCtrl.ChangeValue(panel.passINC[item[0]])\n else:\n userPasswordCtrl.ChangeValue('')\n\n def validation():\n flag = True\n label = labelCtrl.GetValue()\n if label == \"\":\n flag = False\n else:\n if [n[0] for n in panel.cfgs].count(label)!=1:\n flag = False\n if not validateEmailAddr(mailAddressCtrl.GetValue()):\n flag = False\n replAddr = replAddressCtrl.GetValue()\n if replAddr != '' and not validateEmailAddr(replAddr):\n flag = False\n if incServerCtrl.GetValue() == '':\n flag = False\n if incPortCtrl.GetValue() < 0:\n flag = False\n if userLoginCtrl.GetValue() == '':\n flag = False\n if userPasswordCtrl.GetValue() == '':\n flag = False\n if panel.outServerCtrl.GetSelection() == -1:\n flag = False\n panel.dialog.buttonRow.applyButton.Enable(flag)\n panel.dialog.buttonRow.okButton.Enable(flag)\n btnApp.Enable(flag)\n\n panel.validation = validation\n leftSizer = wx.BoxSizer(wx.VERTICAL)\n topLeftSizer = wx.FlexGridSizer(5,2,2,8)\n leftSizer.Add(topLeftSizer,0,wx.EXPAND)\n topMiddleSizer=wx.BoxSizer(wx.VERTICAL)\n previewLbl=wx.StaticText(panel, -1, text.accountsList)\n listBoxCtrl=wx.ListBox(\n panel,-1,\n size=wx.Size(120,106),\n style=wx.LB_SINGLE|wx.LB_NEEDED_SB\n )\n labelLbl=wx.StaticText(panel, -1, text.label)\n labelCtrl=wx.TextCtrl(panel,-1,'')\n choiceType = wx.RadioBox(\n panel,\n -1,\n text.accType,\n choices=(text.eBoxCase),\n style=wx.RA_SPECIFY_ROWS\n )\n #Box content\n userNameLbl=wx.StaticText(panel, -1, text.userName)\n userNameCtrl=wx.TextCtrl(panel,-1,'')\n userNameCtrl.SetMaxSize((194,-1))\n mailAddressLbl=wx.StaticText(panel, -1, text.mailAddress)\n mailAddressCtrl=wx.TextCtrl(panel,-1,'')\n replAddressLbl=wx.StaticText(panel, -1, text.replAddress)\n replAddressCtrl=wx.TextCtrl(panel,-1,'')\n incServerLbl=wx.StaticText(panel, -1, text.incServer)\n incServerCtrl=wx.TextCtrl(panel,-1,'')\n incPortLbl=wx.StaticText(panel, -1, text.incPort)\n incPortCtrl=intCtrl(panel,-1,0,size=(50,-1))\n userLoginLbl=wx.StaticText(panel, -1, text.userLogin)\n userLoginCtrl=wx.TextCtrl(panel,-1,'')\n userPasswordLbl=wx.StaticText(panel, -1, text.userPassword)\n userPasswordCtrl=wx.TextCtrl(panel,-1,'',style = wx.TE_PASSWORD)\n outServerLbl=wx.StaticText(panel, -1, text.outServer)\n panel.outServerCtrl=wx.Choice(\n panel,\n -1,\n choices = [n[0] for n in panel.servers],\n )\n outServerBtn = wx.Button(panel,-1,'...',size=(50,-1))\n viewerBtn = wx.Button(panel,-1,text.viewerTitle)\n panel.txtsBtn = wx.Button(panel,-1,text.textsTitle)\n panel.grpsBtn = wx.Button(panel,-1,text.groupsTitle)\n choiceSecureLbl =wx.StaticText(panel, -1, text.secureConnectLabel)\n choiceSecureCtrl = wx.Choice(\n panel,\n -1,\n choices=(text.secureConnectChoice1),\n )\n choiceSecureCtrl.SetMaxSize((194,-1))\n useSecureCtrl = wx.CheckBox(panel, label = text.useSecure)\n serverSizer = wx.BoxSizer(wx.HORIZONTAL)\n serverSizerL = wx.BoxSizer(wx.VERTICAL)\n serverSizerL.Add(incServerLbl,0,wx.EXPAND)\n serverSizerL.Add(incServerCtrl,0,wx.EXPAND)\n serverSizerR = wx.BoxSizer(wx.VERTICAL)\n serverSizerR.Add(incPortLbl,0,wx.EXPAND|wx.LEFT,3)\n serverSizerR.Add(incPortCtrl,0,wx.EXPAND)\n serverSizer.Add(serverSizerL,1,wx.EXPAND)\n serverSizer.Add(serverSizerR,0,wx.EXPAND|wx.LEFT,5)\n outServSizer = wx.BoxSizer(wx.HORIZONTAL)\n outServSizerL = wx.BoxSizer(wx.VERTICAL)\n outServSizerL.Add(outServerLbl,0,wx.EXPAND|wx.TOP,3)\n outServSizerL.Add(panel.outServerCtrl,0,wx.EXPAND)\n outServSizerR = wx.BoxSizer(wx.VERTICAL)\n outServSizerR.Add(outServerBtn,0,wx.EXPAND|wx.TOP,15)\n outServSizer.Add(outServSizerL,1,wx.EXPAND)\n outServSizer.Add(outServSizerR,0,wx.EXPAND|wx.LEFT,5)\n box = wx.StaticBox(panel,-1,text.param)\n rightSizer = wx.StaticBoxSizer(box,wx.VERTICAL)\n rightSizer.Add(userNameLbl,0,wx.TOP,3)\n rightSizer.Add(userNameCtrl,0,wx.EXPAND)\n rightSizer.Add(userLoginLbl,0,wx.TOP,3)\n rightSizer.Add(userLoginCtrl,0,wx.EXPAND)\n rightSizer.Add(userPasswordLbl,0,wx.TOP,3)\n rightSizer.Add(userPasswordCtrl,0,wx.EXPAND)\n rightSizer.Add(mailAddressLbl,0,wx.TOP,3)\n rightSizer.Add(mailAddressCtrl,0,wx.EXPAND)\n rightSizer.Add(replAddressLbl,0,wx.TOP,3)\n rightSizer.Add(replAddressCtrl,0,wx.EXPAND)\n rightSizer.Add(useSecureCtrl,0,wx.TOP,5)\n rightSizer.Add(choiceSecureLbl,0,wx.TOP,3)\n rightSizer.Add(choiceSecureCtrl,0,wx.EXPAND)\n rightSizer.Add(serverSizer,0,wx.EXPAND|wx.TOP,3)\n rightSizer.Add(outServSizer,0,wx.EXPAND|wx.TOP,3)\n topLeftSizer.Add(previewLbl,0,wx.TOP,5)\n topLeftSizer.Add((1,1))\n topLeftSizer.Add(listBoxCtrl,0,wx.TOP,5)\n topLeftSizer.Add(topMiddleSizer,0,wx.TOP,5)\n topLeftSizer.Add(labelLbl,0,wx.TOP,3)\n topLeftSizer.Add((1,1))\n topLeftSizer.Add(labelCtrl,0,wx.EXPAND)\n topLeftSizer.Add((1,1))\n topLeftSizer.Add(choiceType,0,wx.EXPAND|wx.TOP,1)\n topLeftSizer.Add((1,1))\n leftSizer.Add(viewerBtn,0,wx.EXPAND|wx"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227997,"cells":{"text":{"kind":"string","value":"# -*- coding: utf-8 -*-\n#\n# blitz_gateway - python bindings and wrappers to access an OMERO blitz server\n# \n# Copyright (c) 2007, 2010 Glencoe Software, Inc. All rights reserved.\n# \n# This software is distributed under the terms described by the LICENCE file\n# you can find at the root of the distribution bundle, which states you are\n# free to use it only for non commercial purposes.\n# If the file is missing please request a copy by contacting\n# jason@glencoesoftware.com.\n\n# Set up the python include paths\nimport os,sys\nTHISPATH = os.path.dirname(os.path.abspath(__file__))\n\nimport warnings\nimport shutil\nimport tempfile\nfrom types import IntType, LongType, UnicodeType, ListType, TupleType, StringType, StringTypes\nfrom datetime import datetime\nfrom cStringIO import StringIO\nimport ConfigParser\n\nimport omero\nimport omero.clients\nfrom omero.util.decorators import timeit, TimeIt, setsessiongroup\nfrom omero.cmd import Chgrp, DoAll\nfrom omero.api import Save\nfrom omero.callbacks import CmdCallbackI\nfrom omero.gateway.utils import ServiceOptsDict, GatewayConfig\nimport omero.scripts as scripts\n\nimport Ice\nimport Glacier2\n\nimport traceback\nimport time\nimport array\nimport math\n\nimport logging\nlogger = logging.getLogger(__name__)\n\ntry:\n import Image, ImageDraw, ImageFont\nexcept: #pragma: nocover\n try:\n from PIL import Image, ImageDraw, ImageFont\n except:\n logger.error('No PIL installed, line plots and split channel will fail!')\nfrom cStringIO import StringIO\nfrom math import sqrt\n\nfrom omero.rtypes import rstring, rint, rlong, rbool, rtime, rlist, rdouble, unwrap\n\ndef omero_type(val):\n \"\"\"\n Converts rtypes from static factory methods:\n - StringType to rstring\n - UnicodeType to rstring\n - IntType to rint\n - LongType to rlong\n elswere return the argument itself\n\n @param val: value \n @rtype: omero.rtype\n @return: matched RType or value\n \"\"\"\n \n if isinstance(val, StringType):\n return rstring(val)\n elif isinstance(val, UnicodeType):\n return rstring(val.encode('utf-8'))\n elif isinstance(val, IntType):\n return rint(val)\n elif isinstance(val, LongType):\n return rlong(val)\n else:\n return val\n\ndef fileread (fin, fsize, bufsize):\n \"\"\"\n Reads everything from fin, in chunks of bufsize.\n\n \n @type fin: file\n @param fin: filelike readable object\n @type fsize: int\n @param fsize: total number of bytes to read\n @type bufsize: int\n @param fsize: size of each chunk of data read from fin\n @rtype: string\n @return: string buffer holding the contents read from the file\n \"\"\"\n # Read it all in one go\n p = 0\n rv = ''\n while p < fsize:\n s = min(bufsize, fsize-p)\n rv += fin.read(p,s)\n p += s\n fin.close()\n return rv\n \n\ndef fileread_gen (fin, fsize, bufsize):\n \"\"\"\n Generator helper function that yields chunks of the file of size fsize. \n\n @type fin: file\n @param fin: filelike readable object\n @type fsize: int\n @param fsize: total number of bytes to read\n @type bufsize: int\n @param fsize: size of each chunk of data read from fin that gets yielded\n @rtype: generator\n @return: generator of string buffers of size up to bufsize read from fin\n \"\"\"\n p = 0\n while p < fsize:\n s = min(bufsize, fsize-p)\n yield fin.read(p,s)\n p += s\n fin.close()\n\nclass BlitzObjectWrapper (object):\n \"\"\"\n Object wrapper class which provides various methods for hierarchy traversing, \n saving, handling permissions etc. \n This is the 'abstract' super class which is subclassed by \n E.g. _ProjectWrapper, _DatasetWrapper etc. \n All ojbects have a reference to the L{BlitzGateway} connection, and therefore all services are\n available for handling calls on the object wrapper. E.g listChildren() uses queryservice etc.\n \"\"\"\n \n OMERO_CLASS = None # E.g. 'Project', 'Dataset', 'Experimenter' etc. \n LINK_CLASS = None\n LINK_CHILD = 'child'\n CHILD_WRAPPER_CLASS = None\n PARENT_WRAPPER_CLASS = None\n\n @staticmethod\n def LINK_PARENT (x):\n return x.parent\n\n def __init__ (self, conn=None, obj=None, cache=None, **kwargs):\n \"\"\"\n Initialises the wrapper object, setting the various class variables etc\n \n @param conn: The L{omero.gateway.BlitzGateway} connection.\n @type conn: L{omero.gateway.BlitzGateway}\n @param obj: The object to wrap. E.g. omero.model.Image\n @type obj: omero.model object\n @param cache: Cache which is passed to new child wrappers\n \"\"\"\n self.__bstrap__()\n self._obj = obj\n self._cache = cache\n if self._cache is None:\n self._cache = {}\n self._conn = conn\n self._creationDate = None\n if conn is None:\n return\n if hasattr(obj, 'id') and obj.id is not None:\n self._oid = obj.id.val\n if not self._obj.loaded:\n self._obj = self._conn.getQueryService().get(self._obj.__class__.__name__, self._oid, self._conn.SERVICE_OPTS)\n self.__prepare__ (**kwargs)\n\n def __eq__ (self, a):\n \"\"\"\n Returns true if the object is of the same type and has same id and name\n \n @param a: The object to compare to this one\n @return: True if objects are same - see above\n @rtype: Boolean\n \"\"\"\n return type(a) == type(self) and self._obj.id == a._obj.id and self.getName() == a.getName()\n\n def __bstrap__ (self):\n \"\"\" Initialisation method which is implemented by subclasses to set their class variables etc. \"\"\"\n pass\n\n def __prepare__ (self, **kwargs):\n \"\"\" Initialisation method which is implemented by subclasses to handle various init tasks \"\"\"\n pass\n\n def __repr__ (self):\n \"\"\"\n Returns a String representation of the Object, including ID if set. \n \n @return: String E.g. '<DatasetWrapper id=123>'\n @rtype: String\n \"\"\"\n if hasattr(self, '_oid'):\n return '<%s id=%s>' % (self.__class__.__name__, str(self._oid))\n return super(BlitzObjectWrapper, self).__repr__()\n \n def _getQueryString(self):\n \"\"\"\n Used for building queries in generic methods such as getObjects(\"Project\")\n \"\"\"\n return \"select obj from %s obj join fetch obj.details.owner as owner join fetch obj.details.group \"\\\n \"join fetch obj.details.creationEvent\" % self.OMERO_CLASS\n\n def _getChildWrapper (self):\n \"\"\"\n Returns the wrapper class of children of this object. \n Checks that this is one of the Wrapper objects in the L{omero.gateway} module\n Raises NotImplementedError if this is not true or class is not defined (None)\n This is used internally by the L{listChildren} and L{countChildren} methods. \n \n @return: The child wrapper class. E.g. omero.gateway.DatasetWrapper.__class__\n @rtype: class\n \"\"\"\n if self.CHILD_WRAPPER_CLASS is None: #pragma: no cover\n raise NotImplementedError('%s has no child wrapper defined' % self.__class__)\n if type(self.CHILD_WRAPPER_CLASS) is type(''):\n # resolve class\n if hasattr(omero.gateway, self.CHILD_WRAPPER_CLASS):\n self.__class__.CHILD_WRAPPER_CLASS = self.CHILD_WRAPPER_CLASS = getattr(omero.gateway, self.CHILD_WRAPPER_CLASS)\n else: #pragma: no cover\n raise NotImplementedError\n return self.CHILD_WRAPPER_CLASS\n\n def _getParentWrappers (self):\n \"\"\"\n Returns the wrapper classes of the parent of this object. \n This is used internally by the L{listParents} method.\n \n @return: List of parent wrapper classes. E.g. omero.gateway.DatasetWrapper.__class__\n @rtype: class\n \"\"\"\n if self.PARENT_WRAPPER_CLASS is None: #pragma: no cover\n raise NotImplementedError\n pwc = self.PARENT_WRAPPER_CLASS\n if not isinstance(pwc, ListType):\n pwc = [pwc,]\n for i in range(len(pwc)):\n if isinstance(pwc[i], StringTypes):\n # resolve class\n g = globals()\n if not g.has_key(pwc[i]): #pragma: no cover\n raise NotImplementedError\n pwc[i] = g[pwc[i]]\n \n #if type(self.PARENT_WRAPPER_CLASS) is type(''):\n # # resolve class\n # g = globals()\n # if not g.has_key(self.PARENT_WRAPPER_CLASS): #pragma: no cover\n # raise NotImplementedError\n # self.__class__.PARENT_WRAPPER_CLASS = self.PARENT_WRAPPER_CLASS = g[self.PARENT_WRAPPER_CLASS]\n #return self.PARENT_WRAPPER_CLASS\n if pwc != self.PARENT_WRAPPER_CLASS or pwc != self.__class__.PARENT_WRAPPER_CLASS:\n self.__class__.PARENT_WRAPPER_CLASS = self.PARENT_WRAPPER_CLASS = pwc\n return self.PARENT_WRAPPER_CLASS\n\n def __loadedHotSwap__ (self):\n \"\"\"\n Loads the object that is wrapped by this class. This includes linked objects. \n This method can be overwritten by subclasses that want to specify how/which linked objects \n are loaded. \n \"\"\"\n self._obj = self._conn.getContainerService().loadContainerHierarchy(self.OMERO_CLASS, (self._oid,), None, self._conn.SERVICE_OPTS)[0]\n\n def _moveLink (self, newParent):\n \"\"\" \n Moves this object from a parent container (first one if there are more than one) to a new parent.\n TODO: might be more useful if it didn't assume only 1 parent - option allowed you to specify the oldParent.\n \n @param newParent: The new parent Object Wrapper. \n @return: True if moved from parent to parent. \n False if no parent exists or newParent has mismatching type\n @rtype: Boolean\n \"\"\"\n p = self.getParent()\n # p._obj.__class__ == p._obj.__class__ ImageWrapper(omero.model.DatasetI())\n if p.OMERO_CLASS == newParent.OMERO_CLASS:\n link = self._conn.getQueryService().findAllByQuery(\"select l from %s as l where l.parent.id=%i and l.child.id=%i\" % (p.LINK_CLASS, p.id, self.id), None, self._conn.SERVICE_OPTS)\n if len(link):\n link[0].parent = newParent._obj\n self._conn.getUpdateService().saveObject(link[0], self._conn.SERVICE_OPTS)\n return True\n logger.debug(\"## query didn't return objects: 'select l from %s as l where l.parent.id=%i and l.child.id=%i'\" % (p.LINK_CLASS, p.id, self.id))\n else:\n logger.debug(\"## %s != %s ('%s' - '%s')\" % (type(p), type(newParent), str(p), str(newParent)))\n return False\n\n def findChildByName (self, name, description=None):\n \"\"\"\n Find the first child object with a matching name, and description if specified.\n \n @param name: The name which must match the child name\n @param description: If specified, child description must match too\n @return: The wrapped child object\n @rtype: L{BlitzObjectWrapper}\n \"\"\"\n for c in self.listChildren():\n if c.getName() == name:\n if description is None or omero_type(description) == omero_type(c.getDescription()):\n return c\n return None\n\n def getDetails (self):\n \"\"\"\n Gets the details of the wrapped object\n \n @return: L{omero.gateway.DetailsWrapper} or None if object not loaded\n @rtype: L{DetailsWrapper}\n \"\"\"\n if self._obj.loaded:\n return omero.gateway.DetailsWrapper (self._conn, self._obj.getDetails())\n return None\n \n \n def getDate(self):\n \"\"\"\n Returns the object's acquisitionDate, or creation date (details.creationEvent.time)\n \n @return: A L{datetime.datetime} object \n @rtype: datetime\n \"\"\"\n \n try:\n if self._obj.acquisitionDate.val is not None and self._obj.acquisitionDate.val > 0:\n t = self._obj.acquisitionDate.val\n return datetime.fromtimestamp(t/1000)\n except:\n # object doesn't have acquisitionDate\n pass\n \n return self.creationEventDate()\n \n \n def save (self):\n \"\"\" \n Uses the updateService to save the wrapped object.\n \n @rtype: None\n \"\"\"\n ctx = self._conn.SERVICE_OPTS.copy()\n if self.getDetails() and self.getDetails().getGroup():\n # This is a save for an object that already exists, make sure group matches\n ctx.setOmeroGroup(self.getDetails().getGroup().getId())\n self._obj = self._conn.getUpdateService().saveAndReturnObject(self._obj, ctx)\n\n def saveAs (self, details):\n \"\"\" \n Save this object, keeping the object owner the same as the one on provided details \n If the current user is an admin but is NOT the owner specified in 'details',\n then create a new connection for that owner, clone the current object under that\n connection and save. \n Otherwise, simply save. \n \n @param details: The Details specifying owner to save to\n @type details: L{DetailsWrapper}\n @return: None\n \"\"\"\n if self._conn.isAdmin():\n d = self.getDetails()\n if d.getOwner() and \\\n d.getOwner().omeName == details.getOwner().omeName and \\\n d.getGroup().name == details.getGroup().name:\n return self.save()\n else:\n newConn = self._conn.suConn(details.getOwner().omeName, details.getGroup().name)\n #p = omero.sys.Principal()\n #p.name = details.getOwner().omeName\n #p.group = details.getGroup().name\n #p.eventType = \"User\"\n #newConnId = self._conn.getSessionService().createSessionWithTimeout(p, 60000)\n #newConn = self._conn.clone()\n #newConn.connect(sUuid=newConnId.getUuid().val)\n clone = self.__class__(newConn, self._obj)\n clone.save()\n self._obj = clone._obj\n return\n else:\n return self.save()\n\n def canWrite (self):\n \"\"\" \n Delegates to the connection L{BlitzGateway.canWrite} method\n \n @rtype: Boolean\n \"\"\"\n return self._conn.canWrite(self)\n\n def canOwnerWrite (self):\n \"\"\"\n Delegates to the connection L{BlitzGateway.canWrite} method\n \n @rtype: Boolean\n @return: True if the objects's permissions allow owner to write\n \"\"\"\n return self._conn.canOwnerWrite(self)\n \n def isOwned(self):\n \"\"\"\n Returns True if the object owner is the same user specified in the connection's Event Context\n \n @rtype: Boolean\n @return: True if current user owns this object\n \"\"\"\n return (self._obj.details.owner.id.val == self._conn.getUserId())\n \n def isLeaded(self):\n \"\"\"\n Returns True if the group that this object belongs to is lead by the currently logged-in user\n \n @rtype: Boolean\n @return: see above\n \"\"\"\n g = self._obj.details.group or self._obj.details \n if g.id.val in self._conn.getEventContext().leaderOfGroups:\n return True\n return False\n \n def isPublic(self):\n \"\"\"\n Determines if the object permissions are world readable, ie permissions.isWorldRead()\n \n @rtype: Boolean\n @return: see above\n \"\"\"\n g = self.getDetails().getGroup()\n g = g and g.details or self._obj.details\n return g.permissions.isWorldRead()\n \n def isShared(self):\n \"\"\"\n Determines if the object is sharable between groups (but not public) \n \n @rtype: Boolean\n @return: True if the object is not L{public<isPublic>} AND the \n object permissions allow group read.\n \"\"\"\n if not self.isPublic():\n g = self.getDetails().getGroup()\n g = g and g.details or self._obj.details\n return g.permissions.isGroupRead()\n return False\n \n def isPrivate(self):\n \"\"\"\n Determines if the object is private\n \n @rtype: Boolean\n @return: True if the object is not L{public<isPublic>} and not L{shared<isShared>} and \n permissions allow user to read.\n \"\"\"\n if not self.isPublic() and not self.isShared():\n g = self.getDetails().getGroup()\n g = g and g.details or self._obj.details\n return g.permissions.isUserRead()\n return False\n\n def canEdit(self):\n \"\"\"\n Determines if the current user can Edit (E.g. name, description) link (E.g. Project, Dataset, Image etc)\n or Delete this object. The canEdit() property is set on the permissions of every object as\n it is read from the server, based on the current user, event context and group permissions.\n\n @rtype: Boolean\n @return: True if user can Edit this object Delete, link etc.\n \"\"\"\n return self.getDetails().getPermissions().canEdit()\n\n def canDelete(self):\n \"\"\"\n Determines if the current user can Delete the object\n \"\"\"\n return self.getDetails().getPermissions().canDelete()\n\n def canLink(self):\n \"\"\"\n Determines whether user can create 'hard' links (Not annotation links).\n E.g. Between Project/Dataset/Image etc.\n We have decided to restrict the clients to only allow the OWNER of data\n to create these links.\n The server is more permissive. To see what the server will allow,\n use self.getDetails().getPermissions().canLink()\n \"\"\"\n return self.isOwned()\n\n def canAnnotate(self):\n \"\"\"\n Determines if the current user can annotate this object: ie create annotation links.\n The canAnnotate() property is set on the permissions of every object as\n it is read from the server, based on the current user, event context and group permissions.\n\n @rtype: Boolean\n @return: True if user can Annotate this object\n \"\"\"\n return self.getDetails().getPermissions().canAnnotate()\n\n def canChgrp(self):\n \"\"\"\n Specifies whether the current user can move this object to another group. \n Web client will only allow this for the data Owner.\n Admin CAN move other user's data, but we don't support this in Web yet.\n \"\"\"\n return self.isOwned() # or self._conn.isAdmin() #8974\n\n def countChildren (self):\n \"\"\"\n Counts available number of child objects.\n \n @return: The number of child objects available\n @rtype: Long\n \"\"\"\n \n childw = self._getChildWrapper()\n klass = \"%sLinks\" % childw().OMERO_CLASS.lower()\n #self._cached_countChildren = len(self._conn.getQueryService().findAllByQuery(\"from %s as c where c.parent.id=%i\" % (self.LINK_CLASS, self._oid), None))\n self._cached_countChildren = self._conn.getContainerService().getCollectionCount(self.OMERO_CLASS, klass, [self._oid], None, self._conn.SERVICE_OPTS)[self._oid]\n return self._cached_countChildren\n\n def countChildren_cached (self):\n \"\"\"\n countChildren, but caching the first result, useful if you need to call this multiple times in\n a single sequence, but have no way of storing the value between them.\n It is actually a hack to support django template's lack of break in for loops\n \n @return: The number of child objects available\n @rtype: Long\n \"\"\"\n \n if not hasattr(self, '_cached_countChildren'):\n return self.countChildren()\n return self._cached_countChildren\n\n def _listChildren (self, ns=None, val=None, params=None):\n \"\"\"\n Lists available child objects.\n\n @rtype: generator of Ice client proxy objects for the child nodes\n @return: child objects.\n \"\"\"\n if not params:\n params = omero.sys.Parameters()\n if not params.map:\n params.map = {}\n params.map[\"dsid\"] = omero_type(self._oid)\n query = \"select c from %s as c\" % self.LINK_CLASS\n if ns is not None:\n params.map[\"ns\"] = omero_type(ns)\n query += \"\"\" join fetch c.child as ch\n left outer join fetch ch.annotationLinks as ial\n left outer join fetch ial.child as a \"\"\"\n query += \" where c.parent.id=:dsid\"\n if ns is not None:\n query += \" and a.ns=:ns\"\n if val is not None:\n if isinstance(val, StringTypes):\n params.map[\"val\"] = omero_type(val)\n query +=\" and a.textValue=:val\"\n query += \" order by c.child.name\"\n for child in ( x.child for x in self._conn.getQueryService().findAllByQuery(query, params, self._conn.SERVICE_OPTS) ):\n yield child\n\n def listChildren (self, ns=None, val=None, params=None):\n \"\"\"\n Lists available child objects.\n\n @rtype: generator of L{BlitzObjectWrapper} objs\n @return: child objects.\n \"\"\"\n childw = self._getChildWrapper()\n for child in self._listChildren(ns=ns, val=val, params=params):\n yield childw(self._conn, child, self._cache)\n\n def getParent (self, withlinks=False):\n \"\"\"\n List a single parent, if available.\n\n While the model suports many to many relationships between most objects, there are\n implementations that assume a single project per dataset, a single dataset per image,\n etc. This is just a shortcut method to return a single parent object.\n\n @type withlinks: Boolean\n @param withlinks: if true result will be a tuple of (linkobj, obj)\n @rtype: L{BlitzObjectWrapper} ( or tuple(L{BlitzObjectWrapper}, L{BlitzObjectWrapper}) )\n @return: the parent object with or without the link depending on args\n \"\"\"\n\n rv = self.listParents(withlinks=withlinks)\n return len(rv) and rv[0] or None\n\n def listParents (self, withlinks=False):\n \"\"\"\n Lists available parent objects.\n\n @type withlinks: Boolean\n @param withlinks: if true each yielded result will be a tuple of (linkobj, obj)\n @rtype: list of L{BlitzObjectWrapper} ( or tuple(L{BlitzObjectWrapper}, L{BlitzObjectWrapper}) )\n @return: the parent objects, with or without the links depending on args\n \"\"\"\n if self.PARENT_WRAPPER_CLASS is None:\n return ()\n parentw = self._getParentWrappers()\n param = omero.sys.Parameters() # TODO: What can I use this for?\n parentnodes = []\n for pwc in parentw:\n pwck = pwc()\n if withlinks:\n parentnodes.extend([(pwc(self._conn, pwck.LINK_PARENT(x), self._cache), BlitzObjectWrapper(self._conn, x)) for x in self._conn.getQueryService().findAllByQuery(\"from %s as c where c.%s.id=%i\" % (pwck.LINK_CLASS, pwck.LINK_CHILD, self._oid), param, self._conn.SERVICE_OPTS)])\n else:\n t = self._conn.getQueryService().findAllByQuery(\"from %s as c where c.%s.id=%i\" % (pwck.LINK_CLASS, pwck.LINK_CHILD, self._oid), param, self._conn.SERVICE_OPTS)\n parentnodes.extend([pwc(self._conn, pwck.LINK_PARENT(x), self._cache) for x in t])\n return parentnodes\n\n def getAncestry (self):\n \"\"\"\n Get a list of Ancestors. First in list is parent of this object. \n TODO: Assumes getParent() returns a single parent. \n \n @rtype: List of L{BlitzObjectWrapper}\n @return: List of Ancestor objects\n \"\"\"\n rv = []\n p = self.getParent()\n while p:\n rv.append(p)\n p = p.getParent()\n return rv\n \n def getParentLinks(self, pids=None):\n \"\"\"\n Get a list of parent objects links. \n \n @param pids: List of parent IDs\n @type pids: L{Long}\n @rtype: List of L{BlitzObjectWrapper}\n @return: List of parent object links\n \"\"\"\n \n if self.PARENT_WRAPPER_CLASS is None:\n raise AttributeError(\"This object has no parent objects\")\n parentwrappers = self._getParentWrappers()\n link_class = None\n for v in parentwrappers:\n link_class = v().LINK_CLASS\n if link_class is not None:\n break\n if link_class is None:\n raise AttributeError(\n \"This object has no parent objects with a link class!\")\n query_serv = self._conn.getQueryService()\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"child\"] = rlong(self.id) \n sql = \"select pchl from %s as pchl \" \\\n \"left outer join fetch pchl.parent as parent \" \\\n \"left outer join fetch pchl.child as child \" \\\n \"where child.id=:child\" % link_class\n if isinstance(pids, list) and len(pids) > 0:\n p.map[\"parent\"] = rlist([rlong(pa) for pa in pids])\n sql+=\" and parent.id in (:parent)\"\n for pchl in query_serv.findAllByQuery(sql, p, self._conn.SERVICE_OPTS):\n yield BlitzObjectWrapper(self, pchl) \n \n def getChildLinks(self, chids=None):\n \"\"\"\n Get a list of child objects links. \n \n @param chids: List of children IDs\n @type chids: L{Long}\n @rtype: List of L{BlitzObjectWrapper}\n @return: List of child object links\n \"\"\"\n \n if self.CHILD_WRAPPER_CLASS is None:\n raise AttributeError(\"This object has no child objects\")\n childw = self._getChildWrapper()\n query_serv = self._conn.getQueryService()\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"parent\"] = rlong(self.id) \n sql = \"select pchl from %s as pchl left outer join fetch pchl.child as child \\\n left outer join fetch pchl.parent as parent where parent.id=:parent\" % self.LINK_CLASS\n if isinstance(chids, list) and len(chids) > 0:\n p.map[\"children\"] = rlist([rlong(ch) for ch in chids])\n sql+=\" and child.id in (:children)\"\n for pchl in query_serv.findAllByQuery(sql, p, self._conn.SERVICE_OPTS):\n yield BlitzObjectWrapper(self, pchl) \n\n def _loadAnnotationLinks (self):\n \"\"\" Loads the annotation links for the object (if not already loaded) and saves them to the object \"\"\"\n if not hasattr(self._obj, 'isAnnotationLinksLoaded'): #pragma: no cover\n raise NotImplementedError\n # Need to set group context. If '-1' then canDelete() etc on annotations will be False\n ctx = self._conn.SERVICE_OPTS.copy()\n ctx.setOmeroGroup(self.details.group.id.val)\n if not self._obj.isAnnotationLinksLoaded():\n query = \"select l from %sAnnotationLink as l join fetch l.details.owner join fetch l.details.creationEvent \"\\\n \"join fetch l.child as a join fetch a.details.owner join fetch a.details.creationEvent \"\\\n \"where l.parent.id=%i\" % (self.OMERO_CLASS, self._oid)\n links = self._conn.getQueryService().findAllByQuery(query, None, ctx)\n self._obj._annotationLinksLoaded = True\n self._obj._annotationLinksSeq = links\n\n # _listAnnotationLinks\n def _getAnnotationLinks (self, ns=None):\n \"\"\"\n Checks links are loaded and returns a list of Annotation Links filtered by \n namespace if specified\n \n @param ns: Namespace\n @type ns: String\n @return: List of Annotation Links on this object \n @rtype: List of Annotation Links\n \"\"\"\n self._loadAnnotationLinks()\n rv = self.copyAnnotationLinks()\n if ns is not None:\n rv = filter(lambda x: x.getChild().getNs() and x.getChild().getNs().val == ns, rv)\n return rv\n\n\n def unlinkAnnotations (self, ns):\n \"\"\"\n Uses updateService to unlink annotations, with specified ns\n \n @param ns: Namespace\n @type ns: String\n \"\"\"\n dcs = []\n for al in self._getAnnotationLinks(ns=ns):\n dcs.append(omero.cmd.Delete(\n \"/%s\" % al.ice_id().split(\"::\")[-1], # This could be refactored\n al.id.val, None))\n\n # Using omero.cmd.Delete rather than deleteObjects since we need\n # spec/id pairs rather than spec+id_list as arguments\n if len(dcs):\n doall = omero.cmd.DoAll()\n doall.requests = dcs\n handle = self._conn.c.sf.submit(doall, self._conn.SERVICE_OPTS)\n try:\n self._conn._waitOnCmd(handle)\n finally:\n handle.close()\n self._obj.unloadAnnotationLinks()\n\n def removeAnnotations (self, ns):\n \"\"\"\n Uses the delete service to delete annotations, with a specified ns,\n and their links on the object and any other objects. Will raise a\n L{omero.LockTimeout} if the annotation removal has not finished in\n 5 seconds.\n \n @param ns: Namespace\n @type ns: String\n \"\"\"\n ids = list()\n for al in self._getAnnotationLinks(ns=ns):\n a = al.child\n ids.append(a.id.val)\n if len(ids):\n handle = self._conn.deleteObjects('/Annotation', ids)\n try:\n self._conn._waitOnCmd(handle)\n finally:\n handle.close()\n self._obj.unloadAnnotationLinks() \n \n # findAnnotations(self, ns=[])\n def getAnnotation (self, ns=None):\n \"\"\"\n Gets the first annotation on the object, filtered by ns if specified\n \n @param ns: Namespace\n @type ns: String\n @return: L{AnnotationWrapper} or None\n \"\"\"\n rv = self._getAnnotationLinks(ns)\n if len(rv):\n return AnnotationWrapper._wrap(self._conn, rv[0].child, link=rv[0])\n return None\n\n def listAnnotations (self, ns=None):\n \"\"\"\n List annotations in the ns namespace, linked to this object\n \n @return: Generator yielding L{AnnotationWrapper}\n @rtype: L{AnnotationWrapper} generator\n \"\"\"\n for ann in self._getAnnotationLinks(ns):\n yield AnnotationWrapper._wrap(self._conn, ann.child, link=ann)\n \n def listOrphanedAnnotations(self, eid=None, ns=None, anntype=None):\n \"\"\"\n Retrieve all Annotations not linked to the given Project, Dataset, Image,\n Screen, Plate, Well ID controlled by the security system. \n \n @param o_type: type of Object\n @type o_type: String\n @param oid: Object ID\n @type oid: Long\n @return: Generator yielding Tags\n @rtype: L{AnnotationWrapper} generator\n \"\"\"\n \n if anntype is not None:\n if anntype.title() not in ('Text', 'Tag', 'File', 'Long', 'Boolean'):\n raise AttributeError('It only retrieves: Text, Tag, File, Long, Boolean')\n sql = \"select an from %sAnnotation as an \" % anntype.title()\n else:\n sql = \"select an from Annotation as an \" \\\n \n if anntype.title() == \"File\":\n sql += \" join fetch an.file \"\n \n sql += \"where not exists ( select obal from %sAnnotationLink as obal \"\\\n \"where obal.child=an.id and obal.parent.id=:oid) \" % self.OMERO_CLASS\n \n q = self._conn.getQueryService() \n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"oid\"] = rlong(self._oid)\n if ns is None: \n sql += \" and an.ns is null\"\n else:\n p.map[\"ns\"] = rlist([rstring(n) for n in ns])\n sql += \" and (an.ns not in (:ns) or an.ns is null)\" \n if eid is not None:\n sql += \" and an.details.owner.id=:eid\"\n p.map[\"eid\"] = rlong(eid)\n \n for e in q.findAllByQuery(sql,p,self._conn.SERVICE_OPTS):\n yield AnnotationWrapper._wrap(self._conn, e)\n\n def _linkObject (self, obj, lnkobjtype):\n \"\"\"\n Saves the object to DB if needed - setting the permissions manually.\n Creates the object link and saves it, setting permissions manually.\n TODO: Can't set permissions manually in 4.2 - Assumes world & group writable\n \n @param obj: The object to link\n @type obj: L{BlitzObjectWrapper}\n \"\"\"\n ctx = self._conn.SERVICE_OPTS.copy()\n ctx.setOmeroGroup(self.details.group.id.val)\n if not obj.getId():\n # Not yet in db, save it\n obj = obj.__class__(self._conn, self._conn.getUpdateService().saveAndReturnObject(obj._obj, ctx))\n lnk = getattr(omero.model, lnkobjtype)()\n lnk.setParent(self._obj.__class__(self._obj.id, False))\n lnk.setChild(obj._obj.__class__(obj._obj.id, False))\n self._conn.getUpdateService().saveObject(lnk, ctx)\n return obj\n \n def _linkAnnotation (self, ann):\n \"\"\"\n Saves the annotation to DB if needed - setting the permissions manually.\n Creates the annotation link and saves it, setting permissions manually.\n TODO: Can't set permissions manually in 4.2 - Assumes world & group writable\n \n @param ann: The annotation object\n @type ann: L{AnnotationWrapper}\n \"\"\"\n return self._linkObject(ann, \"%sAnnotationLinkI\" % self.OMERO_CLASS)\n\n def linkAnnotation (self, ann, sameOwner=True):\n \"\"\"\n Link the annotation to this object.\n \n @param ann: The Annotation object\n @type ann: L{AnnotationWrapper}\n @param sameOwner: If True, try to make sure that the link is created by the object owner\n @type sameOwner: Boolean\n @return: The annotation\n @rtype: L{AnnotationWrapper}\n \"\"\"\n \n \"\"\"\n My notes (will) to try and work out what's going on! \n If sameOwner:\n if current user is admin AND they are not the object owner,\n if the object owner and annotation owner are the same:\n use the Annotation connection to do the linking\n else use a new connection for the object owner (?same owner as ann?)\n do linking\n else:\n try to switch the current group of this object to the group of the annotation - do linking\n else - just do linking\n \n \"\"\"\n if sameOwner:\n d = self.getDetails()\n ad = ann.getDetails()\n if self._conn.isAdmin() and self._conn.getUserId() != d.getOwner().id:\n # Keep the annotation owner the same as the linked of object's\n if ad.getOwner() and d.getOwner().omeName == ad.getOwner().omeName and d.getGroup().name == ad.getGroup().name:\n newConn = ann._conn\n else:\n #p = omero.sys.Principal()\n #p.name = d.getOwner().omeName\n group = None\n if d.getGroup():\n group = d.getGroup().name\n # TODO: Do you know that the object owner is same as ann owner??\n newConn = self._conn.suConn(d.getOwner().omeName, group)\n #p.eventType = \"User\"\n #newConnId = self._conn.getSessionService().createSessionWithTimeout(p, 60000)\n #newConn = self._conn.clone()\n #newConn.connect(sUuid=newConnId.getUuid().val)\n clone = self.__class__(newConn, self._obj)\n ann = clone._linkAnnotation(ann)\n if newConn != self._conn:\n newConn.seppuku()\n elif d.getGroup():\n # Try to match group\n # TODO: Should switch session of this object to use group from annotation (ad) not this object (d) ?\n self._conn.setGroupForSession(d.getGroup().getId())\n ann = self._linkAnnotation(ann)\n self._conn.revertGroupForSession()\n else:\n ann = self._linkAnnotation(ann)\n else:\n ann = self._linkAnnotation(ann)\n self.unloadAnnotationLinks()\n return ann\n\n\n def simpleMarshal (self, xtra=None, parents=False):\n \"\"\"\n Creates a dict representation of this object.\n E.g. for Image: {'description': '', 'author': 'Will Moore', 'date': 1286332557.0,\n 'type': 'Image', 'id': 3841L, 'name': 'cb_4_w500_t03_z01.tif'}\n \n @param xtra: A dict of extra keys to include. E.g. 'childCount'\n @type xtra: Dict\n @param parents: If True, include a list of ancestors (in simpleMarshal form) as 'parents'\n @type parents: Boolean\n @return: A dict representation of this object\n @rtype: Dict\n \"\"\"\n rv = {'type': self.OMERO_CLASS,\n 'id': self.getId(),\n 'name': self.getName(),\n 'description': self.getDescription(),\n }\n if hasattr(self, '_attrs'):\n # for each of the lines in _attrs an instance variable named\n # 'key' or 'title' where the line value can be:\n # 'key' -> _obj[key]\n # '#key' -> _obj[key].value.val\n # '()key' -> _obj.getKey()\n # '()#key' -> _obj.getKey().value.val\n # suffix to the above we can have:\n # 'key;title' - will use 'title' as the variable name, instead of 'key'\n # 'key|wrapper' -> omero.gateway.wrapper(_obj[key]).simpleMarshal()\n # 'key|' -> key.simpleMarshal() (useful with ()key )\n for k in self._attrs:\n if ';' in k:\n s = k.split(';')\n k = s[0]\n rk = ';'.join(s[1:])\n else:\n rk = k\n if '|' in k:\n s = k.split('|')\n if rk == k:\n rk = s[0]\n k = s[0]\n wrapper = '|'.join(s[1:])\n else:\n wrapper = None\n \n if k.startswith('()'):\n if k == rk:\n rk = k[2:]\n k = k[2:]\n getter = True\n else:\n getter = False\n\n if k.startswith('#'):\n k = k[1:]\n unwrap = True\n else:\n unwrap = False\n\n if getter:\n v = getattr(self, 'get'+k[0].upper()+k[1:])()\n else:\n v = getattr(self, k)\n if unwrap and v is not None:\n v = v._value\n if wrapper is not None and v is not None:\n if wrapper == '':\n if isinstance(v, ListType):\n v = map(lambda x: x.simpleMarshal(), v)\n else:\n v = v.simpleMarshal()\n else:\n v = getattr(omero.gateway, wrapper)(self._conn, v).simpleMarshal()\n\n rv[rk] = v\n if xtra: # TODO check if this can be moved to a more specific place\n if xtra.has_key('childCount'):\n rv['child_count'] = self.countChildren()\n if parents:\n rv['parents'] = map(lambda x: x.simpleMarshal(), self.getAncestry())\n return rv\n\n #def __str__ (self):\n # if hasattr(self._obj, 'value'):\n # return str(self.value)\n # return str(self._obj)\n\n def __getattr__ (self, attr):\n \"\"\"\n Attempts to return the named attribute of this object. E.g. image.__getattr__('name') or 'getName'\n In cases where the attribute E.g. 'getImmersion' should return an enumeration, this is specified by the\n attr name starting with '#' #immersion.\n In cases where the attribute E.g. 'getLightSource' should return a wrapped object, this is handled\n by the parent encoding the wrapper in the attribute name. E.g 'lightSource|LightSourceWrapper'\n In both cases this returns a method that will return the object.\n In addition, lookup of methods that return an rtype are wrapped to the method instead returns a primitive type.\n E.g. image.getArchived() will return a boolean instead of rbool.\n\n @param attr: The name of the attribute to get\n @type attr: String\n @return: The named attribute.\n @rtype: method, value (string, long etc)\n \"\"\"\n \n # handle lookup of 'get' methods, using '_attrs' dict to define how we wrap returned objects. \n if attr != 'get' and attr.startswith('get') and hasattr(self, '_attrs'):\n tattr = attr[3].lower() + attr[4:] # 'getName' -> 'name'\n attrs = filter(lambda x: tattr in x, self._attrs) # find attr with 'name'\n for a in attrs:\n if a.startswith('#') and a[1:] == tattr:\n v = getattr(self, tattr)\n if v is not None:\n v = v._value\n def wrap ():\n return v\n return wrap\n if len(a) > len(tattr) and a[len(tattr)] == '|': # E.g. a = lightSource|LightSourceWrapper\n def wrap (): # E.g. method returns a LightSourceWrapper(omero.model.lightSource)\n return getattr(omero.gateway, a[len(tattr)+1:])(self._conn, getattr(self, tattr))\n return wrap\n\n # handle lookup of 'get' methods when we don't have '_attrs' on the object, E.g. image.getAcquisitionDate\n if attr != 'get' and attr.startswith('get'):\n attrName = attr[3].lower() + attr[4:] # E.g. getAcquisitionDate -> acquisitionDate\n if hasattr(self._obj, attrName):\n def wrap():\n rv = getattr(self._obj, attrName)\n if hasattr(rv, 'val'):\n return isinstance(rv.val, StringType) and rv.val.decode('utf8') or rv.val\n elif isinstance(rv, omero.model.IObject):\n return BlitzObjectWrapper(self._conn, rv)\n return rv\n return wrap\n\n # handle direct access of attributes. E.g. image.acquisitionDate\n # also handles access to other methods E.g. image.unloadPixels()\n if not hasattr(self._obj, attr) and hasattr(self._obj, '_'+attr):\n attr = '_' + attr\n if hasattr(self._obj, attr):\n rv = getattr(self._obj, attr)\n if hasattr(rv, 'val'): # unwrap rtypes\n return isinstance(rv.val, StringType) and rv.val.decode('utf8') or rv.val\n return rv\n raise AttributeError(\"'%s' object has no attribute '%s'\" % (self._obj.__class__.__name__, attr))\n\n\n # some methods are accessors in _obj and return and omero:: type. The obvious ones we wrap to return a python type\n \n def getId (self):\n \"\"\"\n Gets this object ID\n \n @return: Long or None\n \"\"\"\n oid = self._obj.getId()\n if oid is not None:\n return oid.val\n return None\n\n def getName (self):\n \"\"\"\n Gets this object name\n \n @return: String or None\n \"\"\"\n if hasattr(self._obj, 'name'):\n if hasattr(self._obj.name, 'val'):\n return self._obj.getName().val\n else:\n return self._obj.getName()\n else:\n return None\n\n def getDescription (self):\n \"\"\"\n Gets this object description\n \n @return: String\n \"\"\"\n rv = hasattr(self._obj, 'description') and self._obj.getDescription() or None\n return rv and rv.val or ''\n\n def getOwner (self):\n \"\"\"\n Gets user who is the owner of this object.\n \n @return: _ExperimenterWrapper\n \"\"\"\n return self.getDetails().getOwner()\n\n def getOwnerFullName (self):\n \"\"\"\n Gets full name of the owner of this object.\n \n @return: String or None\n \"\"\"\n try:\n lastName = self.getDetails().getOwner().lastName\n firstName = self.getDetails().getOwner().firstName\n middleName = self.getDetails().getOwner().middleName\n \n if middleName is not None and middleName != '':\n name = \"%s %s. %s\" % (firstName, middleName, lastName)\n else:\n name = \"%s %s\" % (firstName, lastName)\n return name\n except:\n logger.error(traceback.format_exc())\n return None\n\n def getOwnerOmeName (self):\n \"\"\"\n Gets omeName of the owner of this object.\n \n @return: String\n \"\"\"\n return self.getDetails().getOwner().omeName\n\n \n def creationEventDate(self):\n \"\"\"\n Gets event time in timestamp format (yyyy-mm-dd hh:mm:ss.fffffff) when object was created.\n \n @return: The datetime for object creation\n @rtype: datetime.datetime\n \"\"\"\n \n if self._creationDate is not None:\n return datetime.fromtimestamp(self._creationDate/1000)\n \n try:\n if self._obj.details.creationEvent._time is not None:\n self._creationDate = self._obj.details.creationEvent._time.val\n else:\n self._creationDate = self._conn.getQueryService().get(\"Event\", self._obj.details.creationEvent.id.val, self._conn.SERVICE_OPTS).time.val\n except:\n self._creationDate = self._conn.getQueryService().get(\"Event\", self._obj.details.creationEvent.id.val, self._conn.SERVICE_OPTS).time.val\n return datetime.fromtimestamp(self._creationDate/1000)\n \n\n def updateEventDate(self):\n \"\"\"\n Gets event time in timestamp format (yyyy-mm-dd hh:mm:ss.fffffff) when object was updated.\n \n @return: The datetime for object update\n @rtype: datetime.datetime\n \"\"\"\n \n try:\n if self._obj.details.updateEvent.time is not None:\n t = self._obj.details.updateEvent.time.val\n else:\n t = self._conn.getQueryService().get(\"Event\", self._obj.details.updateEvent.id.val, self._conn.SERVICE_OPTS).time.val\n except:\n t = self._conn.getQueryService().get(\"Event\", self._obj.details.updateEvent.id.val, self._conn.SERVICE_OPTS).time.val\n return datetime.fromtimestamp(t/1000)\n\n\n # setters are also provided\n \n def setName (self, value):\n \"\"\"\n Sets the name of the object\n \n @param value: New name\n @type value: String\n \"\"\"\n self._obj.setName(omero_type(value))\n\n def setDescription (self, value):\n \"\"\"\n Sets the description of the object\n \n @param value: New description\n @type value: String\n \"\"\"\n self._obj.setDescription(omero_type(value))\n\n## BASIC ##\n\nclass NoProxies (object):\n \"\"\" A dummy placeholder to indicate that proxies haven't been created \"\"\"\n def __getitem__ (self, k):\n raise Ice.ConnectionLostException\n\n def values (self):\n return ()\n\nclass _BlitzGateway (object):\n \"\"\"\n Connection wrapper. Handles connecting and keeping the session alive, creation of various services,\n context switching, security privilidges etc. \n \"\"\"\n \n \"\"\"\n Holder for class wide configuration properties.\n \"\"\"\n ICE_CONFIG = None\n \"\"\"\n ICE_CONFIG - Defines the path to the Ice configuration\n \"\"\"\n# def __init__ (self, username, passwd, server, port, client_obj=None, group=None, clone=False):\n \n def __init__ (self, username=None, passwd=None, client_obj=None, group=None, clone=False, try_super=False, host=None, port=None, extra_config=None, secure=False, anonymous=True, useragent=None):\n \"\"\"\n Create the connection wrapper. Does not attempt to connect at this stage\n Initialises the omero.client\n \n @param username: User name.\n @type username: String\n @param passwd: Password.\n @type passwd: String\n @param client_obj: omero.client\n @param group: name of group to try to connect to\n @type group: String\n @param clone: If True, overwrite anonymous with False\n @type clone: Boolean\n @param try_super: Try to log on as super user ('system' group) \n @type try_super: Boolean\n @param host: Omero server host. \n @type host: String\n @param port: Omero server port. \n @type port: Integer\n @param extra_config: Dictionary of extra configuration\n @type extra_config: Dict\n @param secure: Initial underlying omero.client connection type (True=SSL/False=insecure)\n @type secure: Boolean\n @param anonymous: \n @type anonymous: Boolean\n @param useragent: Log which python clients use this connection. E.g. 'OMERO.webadmin'\n @type useragent: String\n \"\"\"\n\n if extra_config is None: extra_config = []\n super(_BlitzGateway, self).__init__()\n self.CONFIG = GatewayConfig()\n self.c = client_obj\n if not type(extra_config) in (type(()), type([])):\n extra_config=[extra_config]\n self.extra_config = extra_config\n self.ice_config = [self.ICE_CONFIG]\n self.ice_config.extend(extra_config)\n self.ice_config = map(lambda x: os.path.abspath(str(x)), filter(None, self.ice_config))\n\n self.host = host\n self.port = port\n self.secure = secure\n self.useragent = useragent\n\n self._sessionUuid = None\n self._session_cb = None\n self._session = None\n self._lastGroupId = None\n self._anonymous = anonymous\n self._defaultOmeroGroup = None\n self._defaultOmeroUser = None\n self._maxPlaneSize = None\n\n self._connected = False\n self._user = None\n self._userid = None\n self._proxies = NoProxies()\n if self.c is None:\n self._resetOmeroClient()\n else:\n # if we already have client initialised, we can go ahead and create our services.\n self._connected = True\n self._createProxies()\n self.SERVICE_OPTS = self.createServiceOptsDict()\n if try_super:\n self.group = 'system' #self.c.ic.getProperties().getProperty('omero.gateway.admin_group')\n else:\n self.group = group and group or None\n\n # The properties we are setting through the interface\n self.setIdentity(username, passwd, not clone)\n\n def createServiceOptsDict(self):\n serviceOpts = ServiceOptsDict(self.c.getImplicitContext().getContext())\n serviceOpts.setOmeroGroup(self.getDefaultOmeroGroup())\n serviceOpts.setOmeroUser(self.getDefaultOmeroUser())\n return serviceOpts\n\n def setDefaultOmeroGroup(self, defaultOmeroGroup):\n self._defaultOmeroGroup = defaultOmeroGroup\n\n def setDefaultOmeroUser(self, defaultOmeroUser):\n self._defaultOmeroUser = defaultOmeroUser\n\n def getDefaultOmeroGroup(self):\n return self._defaultOmeroGroup\n\n def getDefaultOmeroUser(self):\n return self._defaultOmeroUser\n\n def getMaxPlaneSize (self):\n \"\"\"\n Returns the maximum plane size the server will allow for an image to not be considered big\n i.e. width or height larger than this will trigger image pyramids to be calculated.\n\n This is useful for the client to filter images based on them needing pyramids or not, without\n the full rendering engine overhead.\n\n @return: tuple holding (max_plane_width, max_plane_height) as set on the server\n @rtype: Tuple\n \"\"\"\n if self._maxPlaneSize is None:\n c = self.getConfigService()\n self._maxPlaneSize = (int(c.getConfigValue('omero.pixeldata.max_plane_width')),\n int(c.getConfigValue('omero.pixeldata.max_plane_height')))\n return self._maxPlaneSize\n \n def isAnonymous (self):\n \"\"\" \n Returns the anonymous flag \n \n @return: Anonymous\n @rtype: Boolean\n \"\"\"\n return not not self._anonymous\n\n def getProperty(self, k):\n \"\"\"\n Returns named property of the wrapped omero.client\n \n @return: named client property\n \"\"\"\n return self.c.getProperty(k)\n\n def clone (self):\n \"\"\"\n Returns a new instance of this class, with all matching properties. \n TODO: Add anonymous and userAgent parameters?\n \n @return: Clone of this connection wrapper\n @rtype: L{_BlitzGateway}\n \"\"\"\n return self.__class__(self._ic_props[omero.constants.USERNAME],\n self._ic_props[omero.constants.PASSWORD],\n host = self.host,\n port = self.port,\n extra_config=self.extra_config,\n clone=True,\n secure=self.secure,\n anonymous=self._anonymous, \n useragent=self.useragent)\n #self.server, self.port, clone=True)\n\n def setIdentity (self, username, passwd, _internal=False):\n \"\"\"\n Saves the username and password for later use, creating session etc\n \n @param username: User name. \n @type username: String\n @param passwd: Password.\n @type passwd: String\n @param _internal: If False, set _anonymous = False\n @type _internal: Booelan\n \"\"\"\n self._ic_props = {omero.constants.USERNAME: username,\n omero.constants.PASSWORD: passwd}\n if not _internal:\n self._anonymous = False\n \n def suConn (self, username, group=None, ttl=60000):\n \"\"\"\n If current user isAdmin, return new connection owned by 'username'\n \n @param username: Username for new connection\n @type username: String\n @param group: If specified, try to log in to this group\n @type group: String\n @param ttl: Timeout for new session\n @type ttl: Int\n @return: Clone of this connection, with username's new Session\n @rtype: L{_BlitzGateway} or None if not admin or username unknown\n \"\"\"\n if self.isAdmin():\n if group is None:\n e = self.getObject(\"Experimenter\", attributes={'omeName': username})\n if e is None:\n return\n group = e._obj._groupExperimenterMapSeq[0].parent.name.val\n p = omero.sys.Principal()\n p.name = username\n p.group = group\n p.eventType = \"User\"\n newConnId = self.getSessionService().createSessionWithTimeout(p, ttl)\n newConn = self.clone()\n newConn.connect(sUuid=newConnId.getUuid().val)\n return newConn\n\n def keepAlive (self):\n \"\"\"\n Keeps service alive. \n Returns True if connected. If connection was lost, reconnecting.\n If connection failed, returns False and error is logged. \n \n @return: True if connection alive. \n @rtype: Boolean\n \"\"\"\n \n try:\n if self.c.sf is None: #pragma: no cover\n logger.debug('... c.sf is None, reconnecting')\n return self.connect()\n return self.c.sf.keepAlive(self._proxies['admin']._getObj())\n except Ice.ObjectNotExistException: #pragma: no cover\n # The connection is there, but it has been reset, because the proxy no longer exists...\n logger.debug(traceback.format_exc())\n logger.debug(\"... reset, not reconnecting\")\n return False\n except Ice.ConnectionLostException: #pragma: no cover\n # The connection was lost. This shouldn't happen, as we keep pinging it, but does so...\n logger.debug(traceback.format_exc())\n logger.debug(\"... lost, reconnecting\")\n #return self.connect()\n return False\n except Ice.ConnectionRefusedException: #pragma: no cover\n # The connection was refused. We lost contact with glacier2router...\n logger.debug(traceback.format_exc())\n logger.debug(\"... refused, not reconnecting\")\n return False\n except omero.SessionTimeoutException: #pragma: no cover\n # The connection is there, but it has been reset, because the proxy no longer exists...\n logger.debug(traceback.format_exc())\n logger.debug(\"... reset, not reconnecting\")\n return False\n except omero.RemovedSessionException: #pragma: no cover\n # Session died on us\n logger.debug(traceback.format_exc())\n logger.debug(\"... session has left the building, not reconnecting\")\n return False\n except Ice.UnknownException, x: #pragma: no cover\n # Probably a wrapped RemovedSession\n logger.debug(traceback.format_exc())\n logger.debug('Ice.UnknownException: %s' % str(x))\n logger.debug(\"... ice says something bad happened, not reconnecting\")\n return False\n except:\n # Something else happened\n logger.debug(traceback.format_exc())\n logger.debug(\"... error not reconnecting\")\n return False\n\n def seppuku (self, softclose=False): #pragma: no cover\n \"\"\"\n Terminates connection with killSession(). If softclose is False, the session is really\n terminate disregarding its connection refcount. \n\n @param softclose: Boolean\n \"\"\"\n self._connected = False\n oldC = self.c\n if oldC is not None:\n try:\n if softclose:\n try:\n r = oldC.sf.getSessionService().getReferenceCount(self._sessionUuid)\n oldC.closeSession()\n if r < 2:\n self._session_cb and self._session_cb.close(self)\n except Ice.OperationNotExistException:\n oldC.closeSession()\n else:\n self._closeSession()\n finally:\n oldC.__del__()\n oldC = None\n self.c = None\n\n self._proxies = NoProxies()\n logger.info(\"closed connecion (uuid=%s)\" % str(self._sessionUuid))\n\n# def __del__ (self):\n# logger.debug(\"##GARBAGE COLLECTOR KICK IN\")\n \n def _createProxies (self):\n \"\"\"\n Creates proxies to the server services. Called on connection or security switch.\n Doesn't actually create any services themselves. Created if/when needed. \n If proxies have been created already, they are resynced and reused. \n \"\"\"\n \n if not isinstance(self._proxies, NoProxies):\n logger.debug(\"## Reusing proxies\")\n for k, p in self._proxies.items():\n p._resyncConn(self)\n else:\n logger.debug(\"## Creating proxies\")\n self._proxies = {}\n self._proxies['admin'] = ProxyObjectWrapper(self, 'getAdminService')\n self._proxies['config'] = ProxyObjectWrapper(self, 'getConfigService')\n self._proxies['container'] = ProxyObjectWrapper(self, 'getContainerService')\n self._proxies['delete'] = ProxyObjectWrapper(self, 'getDeleteService')\n self._proxies['ldap'] = ProxyObjectWrapper(self, 'getLdapService')\n self._proxies['metadata'] = ProxyObjectWrapper(self, 'getMetadataService')\n self._proxies['query'] = ProxyObjectWrapper(self, 'getQueryService')\n self._proxies['pixel'] = ProxyObjectWrapper(self, 'getPixelsService')\n self._proxies['projection'] = ProxyObjectWrapper(self, 'getProjectionService')\n self._proxies['rawpixels'] = ProxyObjectWrapper(self, 'createRawPixelsStore')\n self._proxies['rendering'] = ProxyObjectWrapper(self, 'createRenderingEngine')\n self._proxies['rendsettings'] = ProxyObjectWrapper(self, 'getRenderingSettingsService')\n self._proxies['thumbs'] = ProxyObjectWrapper(self, 'createThumbnailStore')\n self._proxies['rawfile'] = ProxyObjectWrapper(self, 'createRawFileStore')\n self._proxies['repository'] = ProxyObjectWrapper(self, 'getRepositoryInfoService')\n self._proxies['roi'] = ProxyObjectWrapper(self, 'getRoiService')\n self._proxies['script'] = ProxyObjectWrapper(self, 'getScriptService')\n self._proxies['search'] = ProxyObjectWrapper(self, 'createSearchService')\n self._proxies['session'] = ProxyObjectWrapper(self, 'getSessionService')\n self._proxies['share'] = ProxyObjectWrapper(self, 'getShareService')\n self._proxies['sharedres'] = ProxyObjectWrapper(self, 'sharedResources')\n self._proxies['timeline'] = ProxyObjectWrapper(self, 'getTimelineService')\n self._proxies['types'] = ProxyObjectWrapper(self, 'getTypesService')\n self._proxies['update'] = ProxyObjectWrapper(self, 'getUpdateService')\n self._userid = None\n self._user = None\n self._ctx = None\n\n if self._session_cb: #pragma: no cover\n if self._was_join:\n self._session_cb.join(self)\n else:\n self._session_cb.create(self)\n\n def setSecure (self, secure=True):\n \"\"\" \n Switches between SSL and insecure (faster) connections to Blitz.\n The gateway must already be connected.\n \n @param secure: If False, use an insecure connection\n @type secure: Boolean\n \"\"\"\n if hasattr(self.c, 'createClient') and (secure ^ self.c.isSecure()):\n oldC = self.c\n self.c = oldC.createClient(secure=secure)\n oldC.__del__() # only needs to be called if previous doesn't throw\n self._createProxies()\n self.secure = secure\n\n def isSecure (self):\n \"\"\" Returns 'True' if the underlying omero.clients.BaseClient is connected using SSL \"\"\"\n return hasattr(self.c, 'isSecure') and self.c.isSecure() or False\n\n def _getSessionId (self):\n return self.c.getSessionId()\n\n def _createSession (self):\n \"\"\"\n Creates a new session for the principal given in the constructor.\n Used during L{connect} method\n \"\"\"\n s = self.c.createSession(self._ic_props[omero.constants.USERNAME],\n self._ic_props[omero.constants.PASSWORD])\n s.detachOnDestroy()\n self._sessionUuid = self._getSessionId()\n ss = self.c.sf.getSessionService()\n self._session = ss.getSession(self._sessionUuid)\n self._lastGroupId = None\n self._was_join = False\n if self.group is not None:\n # try something that fails if the user don't have permissions on the group\n self.c.sf.getAdminService().getEventContext()\n self.setSecure(self.secure)\n self.c.sf.detachOnDestroy()\n self.SERVICE_OPTS = self.createServiceOptsDict()\n \n def _closeSession (self):\n \"\"\"\n Close session.\n \"\"\"\n self._session_cb and self._session_cb.close(self)\n try:\n if self.c:\n try:\n self.c.getSession()\n except omero.ClientError:\n return # No session available\n self.c.killSession()\n except Glacier2.SessionNotExistException: #pragma: no cover\n pass\n except:\n logger.warn(traceback.format_exc())\n \n def _resetOmeroClient (self):\n \"\"\"\n Creates new omero.client object using self.host or self.ice_config (if host is None)\n Also tries to setAgent for the client\n \"\"\"\n logger.debug(self.host)\n logger.debug(self.port)\n logger.debug(self.ice_config)\n\n if self.c is not None:\n self.c.__del__()\n self.c = None\n\n if self.host is not None:\n if self.port is not None:\n self.c = omero.client(host=str(self.host), port=int(self.port), args=['--Ice.Config='+','.join(self.ice_config)])#, pmap=['--Ice.Config='+','.join(self.ice_config)])\n else:\n self.c = omero.client(host=str(self.host), args=['--Ice.Config='+','.join(self.ice_config)])\n else:\n self.c = omero.client(args=['--Ice.Config='+','.join(self.ice_config)])\n \n if hasattr(self.c, \"setAgent\"):\n if self.useragent is not None:\n self.c.setAgent(self.useragent)\n else:\n self.c.setAgent(\"OMERO.py.gateway\")\n\n def connect (self, sUuid=None):\n \"\"\"\n Creates or retrieves connection for the given sessionUuid.\n Returns True if connected.\n \n @param sUuid: omero_model_SessionI\n @return: Boolean\n \"\"\"\n \n logger.debug(\"Connect attempt, sUuid=%s, group=%s, self.sUuid=%s\" % (str(sUuid), str(self.group), self._sessionUuid))\n if not self.c: #pragma: no cover\n self._connected = False\n logger.debug(\"Ooops. no self._c\")\n return False\n try:\n if self._sessionUuid is None and sUuid:\n self._sessionUuid = sUuid\n if self._sessionUuid is not None:\n try:\n logger.debug('connected? %s' % str(self._connected))\n if self._connected:\n self._connected = False\n logger.debug(\"was connected, creating new omero.client\")\n self._resetOmeroClient()\n s = self.c.joinSession(self._sessionUuid) # timeout to allow this is $ omero config set omero.sessions.timeout 3600000\n s.detachOnDestroy()\n self.SERVICE_OPTS = self.createServiceOptsDict()\n logger.debug('Joined Session OK with Uuid: %s' % (self._sessionUuid,))\n self._was_join = True\n except Ice.SyscallException: #pragma: no cover\n raise\n except Exception, x: #pragma: no cover\n logger.debug(\"Error: \" + str(x))\n self._sessionUuid = None\n if sUuid:\n return False\n if self._sessionUuid is None:\n if sUuid: #pragma: no cover\n logger.debug(\"Uncaptured sUuid failure!\") \n if self._connected:\n self._connected = False\n try:\n logger.debug(\"Closing previous connection...creating new client\")\n #args = self.c._ic_args\n #logger.debug(str(args))\n self._closeSession()\n self._resetOmeroClient()\n #self.c = omero.client(*args)\n except Glacier2.SessionNotExistException: #pragma: no cover\n pass\n setprop = self.c.ic.getProperties().setProperty\n map(lambda x: setprop(x[0],str(x[1])), self._ic_props.items())\n if self._anonymous:\n self.c.ic.getImplicitContext().put(omero.constants.EVENT, 'Internal')\n if self.group is not None:\n self.c.ic.getImplicitContext().put(omero.constants.GROUP, self.group)\n try:\n logger.debug(\"Creating Session...\")\n self._createSession()\n logger.debug(\"Session created\")\n except omero.SecurityViolation:\n if self.group is not None:\n # User don't have access to group\n logger.debug(\"## User not in '%s' group\" % self.group)\n self.group = None\n self._closeSession()\n self._sessionUuid = None\n self._connected=True\n return self.connect()\n else: #pragma: no cover\n logger.debug(\"BlitzGateway.connect().createSession(): \" + traceback.format_exc())\n logger.info('first create session threw SecurityViolation, retry (but only once)')\n #time.sleep(10)\n try:\n self._createSession()\n except omero.SecurityViolation:\n if self.group is not None:\n # User don't have access to group\n logger.debug(\"## User not in '%s' group\" % self.group)\n self.group = None\n self._connected=True\n return self.connect()\n else:\n raise\n except Ice.SyscallException: #pragma: no cover\n raise\n except:\n logger.info(\"Failed to create session.\")\n logger.debug(\"BlitzGateway.connect().createSession(): \" + traceback.format_exc())\n #time.sleep(10)\n self._createSession()\n\n self._last_error = None\n self._createProxies()\n self._connected = True\n logger.info('created connection (uuid=%s)' % str(self._sessionUuid))\n except Ice.SyscallException: #pragma: no cover\n logger.debug('This one is a SyscallException', exc_info=True)\n raise\n except Ice.LocalException, x: #pragma: no cover\n logger.debug(\"connect(): \" + traceback.format_exc())\n self._last_error = x\n return False\n except Exception, x: #pragma: no cover\n logger.debug(\"connect(): \" + traceback.format_exc())\n self._last_error = x\n return False\n logger.debug(\".. connected!\")\n return True\n\n def getLastError (self): #pragma: no cover\n \"\"\"\n Returns error if thrown by _BlitzGateway.connect connect.\n \n @return: String\n \"\"\"\n \n return self._last_error\n\n def isConnected (self):\n \"\"\"\n Returns last status of connection.\n \n @return: Boolean\n \"\"\"\n \n return self._connected\n\n ######################\n ## Connection Stuff ##\n\n def getEventContext (self):\n \"\"\"\n Returns omero_System_ice.EventContext.\n It containes:: \n shareId, sessionId, sessionUuid, userId, userName, \n groupId, groupName, isAdmin, isReadOnly, \n eventId, eventType, eventType,\n memberOfGroups, leaderOfGroups\n Also saves context to self._ctx\n \n @return: Event Context from admin service. \n @rtype: L{omero.sys.EventContext}\n \"\"\"\n if self._ctx is None:\n self._ctx = self._proxies['admin'].getEventContext()\n return self._ctx\n\n def getUserId (self):\n \"\"\"\n Returns current experimenter id\n\n @return: Current Experimenter id\n @rtype: long\n \"\"\"\n if self._userid is None:\n self._userid = self.getEventContext().userId\n return self._userid\n\n def setUserId (self, uid):\n \"\"\"\n Sets current experimenter id\n \"\"\"\n self._userid = uid\n self._user = None\n \n def getUser (self):\n \"\"\"\n Returns current Experimenter.\n \n @return: Current Experimenter\n @rtype: L{ExperimenterWrapper}\n \"\"\"\n if self._user is None:\n uid = self.getUserId()\n if uid is not None:\n self._user = self.getObject(\"Experimenter\", self._userid) or None\n return self._user\n \n def getGroupFromContext(self):\n \"\"\"\n Returns current omero_model_ExperimenterGroupI.\n \n @return: omero.model.ExperimenterGroupI\n \"\"\"\n admin_service = self.getAdminService()\n group = admin_service.getGroup(self.getEventContext().groupId)\n return ExperimenterGroupWrapper(self, group)\n \n def isAdmin (self):\n \"\"\"\n Checks if a user has administration privileges.\n \n @return: Boolean\n \"\"\"\n \n return self.getEventContext().isAdmin\n\n def isLeader(self, gid=None):\n \"\"\"\n Is the current group (or a specified group) led by the current user? \n\n @return: True if user leads the current group\n @rtype: Boolean\n \"\"\"\n if gid is None:\n gid = self.getEventContext().groupId\n if not isinstance(gid, LongType) or not isinstance(gid, IntType):\n gid = long(gid)\n if gid in self.getEventContext().leaderOfGroups:\n return True\n return False\n\n def canBeAdmin (self):\n \"\"\"\n Checks if a user is in system group, i.e. can have administration privileges.\n \n @return: Boolean\n \"\"\"\n return 0 in self.getEventContext().memberOfGroups\n\n def canWrite (self, obj):\n \"\"\"\n Checks if a user has write privileges to the given object.\n \n @param obj: Given object\n @return: Boolean\n \"\"\"\n \n return self.isAdmin() or (self.getUserId() == obj.getDetails().getOwner().getId() and\n obj.getDetails().getPermissions().isUserWrite())\n\n def canOwnerWrite (self, obj):\n \"\"\"\n Returns isUserWrite() from the object's permissions\n \n @param obj: Given object\n @return: True if the objects's permissions allow owner to write\n \"\"\"\n return obj.getDetails().getPermissions().isUserWrite()\n \n def getSession (self):\n \"\"\"\n Returns the existing session, or creates a new one if needed\n \n @return: The session from session service \n @rtype: L{omero.model.session}\n \"\"\"\n if self._session is None:\n ss = self.c.sf.getSessionService()\n self._session = ss.getSession(self._sessionUuid)\n return self._session\n\n# def setDefaultPermissionsForSession (self, permissions):\n# self.getSession()\n# self._session.setDefaultPermissions(rstring(permissions))\n# self._session.setTimeToIdle(None)\n# self.getSessionService().updateSession(self._session)\n\n def setGroupNameForSession (self, group):\n \"\"\"\n Looks up the group by name, then delegates to L{setGroupForSession}, returning the result\n \n @param group: Group name\n @type group: String\n @return: True if group set successfully\n @rtype: Boolean\n \"\"\"\n a = self.getAdminService()\n g = a.lookupGroup(group)\n return self.setGroupForSession(g.getId().val)\n\n def setGroupForSession (self, groupid):\n \"\"\"\n Sets the security context of this connection to the specified group\n \n @param groupid: The ID of the group to switch to\n @type groupid: Long\n @rtype: Boolean\n @return: True if the group was switched successfully\n \"\"\"\n if self.getEventContext().groupId == groupid:\n return None\n if groupid not in self._ctx.memberOfGroups and 0 not in self._ctx.memberOfGroups:\n return False\n self._lastGroupId = self._ctx.groupId\n self._ctx = None\n if hasattr(self.c.sf, 'setSecurityContext'):\n # Beta4.2\n for s in self.c.getStatefulServices():\n s.close()\n self.c.sf.setSecurityContext(omero.model.ExperimenterGroupI(groupid, False))\n else:\n self.getSession()\n self._session.getDetails().setGroup(omero.model.ExperimenterGroupI(groupid, False))\n self._session.setTimeToIdle(None)\n self.getSessionService().updateSession(self._session)\n return True\n\n\n# def setGroupForSession (self, group):\n# self.getSession()\n# if self._session.getDetails().getGroup().getId().val == group.getId():\n# # Already correct\n# return\n# a = self.getAdminService()\n# if not group.name in [x.name.val for x in a.containedGroups(self._userid)]:\n# # User not in this group\n# return\n# self._lastGroup = self._session.getDetails().getGroup()\n# self._session.getDetails().setGroup(group._obj)\n# self._session.setTimeToIdle(None)\n# self.getSessionService().updateSession(self._session)\n#\n def revertGroupForSession (self):\n \"\"\" Switches the group to the previous group \"\"\"\n if self._lastGroupId is not None:\n self.setGroupForSession(self._lastGroupId)\n self._lastGroupId = None\n\n ##############\n ## Services ##\n\n def getAdminService (self):\n \"\"\"\n Gets reference to the admin service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['admin']\n\n def getQueryService (self):\n \"\"\"\n Gets reference to the query service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n return self._proxies['query']\n\n def getContainerService (self):\n \"\"\"\n Gets reference to the container service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['container']\n\n def getPixelsService (self):\n \"\"\"\n Gets reference to the pixels service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['pixel']\n \n def getMetadataService (self):\n \"\"\"\n Gets reference to the metadata service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['metadata']\n \n def getRoiService (self):\n \"\"\"\n Gets ROI service.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['roi']\n \n def getScriptService (self):\n \"\"\"\n Gets script service.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['script']\n \n def createRawFileStore (self):\n \"\"\"\n Creates a new raw file store.\n This service is special in that it does not get cached inside BlitzGateway so every call to this function\n returns a new object, avoiding unexpected inherited states.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['rawfile']\n\n def getRepositoryInfoService (self):\n \"\"\"\n Gets reference to the repository info service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['repository']\n\n def getShareService(self):\n \"\"\"\n Gets reference to the share service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['share']\n\n def getSharedResources(self):\n \"\"\"\n Gets reference to the sharedresources from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['sharedres']\n\n def getTimelineService (self):\n \"\"\"\n Gets reference to the timeline service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['timeline']\n \n def getTypesService(self):\n \"\"\"\n Gets reference to the types service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['types']\n\n def getConfigService (self):\n \"\"\"\n Gets reference to the config service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['config']\n\n def createRenderingEngine (self):\n \"\"\"\n Creates a new rendering engine.\n This service is special in that it does not get cached inside BlitzGateway so every call to this function\n returns a new object, avoiding unexpected inherited states.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n rv = self._proxies['rendering']\n if rv._tainted:\n rv = self._proxies['rendering'] = rv.clone()\n rv.taint()\n return rv\n\n def getRenderingSettingsService (self):\n \"\"\"\n Gets reference to the rendering settings service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['rendsettings']\n \n def createRawPixelsStore (self):\n \"\"\"\n Creates a new raw pixels store.\n This service is special in that it does not get cached inside BlitzGateway so every call to this function\n returns a new object, avoiding unexpected inherited states.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n \n return self._proxies['rawpixels']\n\n def createThumbnailStore (self):\n \"\"\"\n Gets a reference to the thumbnail store on this connection object or creates a new one\n if none exists.\n \n @rtype: omero.gateway.ProxyObjectWrapper\n @return: The proxy wrapper of the thumbnail store\n \"\"\"\n \n return self._proxies['thumbs']\n \n def createSearchService (self):\n \"\"\"\n Gets a reference to the searching service on this connection object or creates a new one\n if none exists.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n return self._proxies['search']\n\n def getUpdateService (self):\n \"\"\"\n Gets reference to the update service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n return self._proxies['update']\n\n def getDeleteService (self):\n \"\"\"\n Gets reference to the delete service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n return self._proxies['delete']\n\n def getSessionService (self):\n \"\"\"\n Gets reference to the session service from ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n return self._proxies['session']\n\n def createExporter (self):\n \"\"\"\n New instance of non cached Exporter, wrapped in ProxyObjectWrapper.\n \n @return: omero.gateway.ProxyObjectWrapper\n \"\"\"\n return ProxyObjectWrapper(self, 'createExporter')\n\n #############################\n # Top level object fetchers #\n\n def listProjects (self, eid=None):\n \"\"\"\n List every Project controlled by the security system.\n\n @param eid: Filters Projects by owner ID\n @rtype: L{ProjectWrapper} list\n \"\"\"\n\n params = omero.sys.Parameters()\n params.theFilter = omero.sys.Filter()\n #if only_owned:\n # params.theFilter.ownerId = rlong(self._userid)\n #elif\n if eid is not None:\n params.theFilter.ownerId = rlong(eid)\n\n return self.getObjects(\"Project\", params=params)\n\n def listScreens(self, eid=None):\n \"\"\"\n List every Screens controlled by the security system.\n\n @param eid: Filters Screens by owner ID\n @rtype: L{ProjectWrapper} list\n \"\"\"\n\n params = omero.sys.Parameters()\n params.theFilter = omero.sys.Filter()\n #if only_owned:\n # params.theFilter.ownerId = rlong(self._userid)\n #elif\n if eid is not None:\n params.theFilter.ownerId = rlong(eid)\n\n return self.getObjects(\"Screen\", params=params)\n \n #################################################\n ## IAdmin\n \n # GROUPS\n \n def listGroups(self):\n \"\"\" \n Look up all experimenters and related groups.\n Groups are also loaded\n \n @return: All experimenters\n @rtype: L{ExperimenterWrapper} generator\n \"\"\"\n \n admin_serv = self.getAdminService()\n for exp in admin_serv.lookupGroups():\n yield ExperimenterGroupWrapper(self, exp)\n\n def getDefaultGroup(self, eid):\n \"\"\"\n Retrieve the default group for the given user id.\n \n @param eid: Experimenter ID\n @type eid: Long\n @return: The default group for user\n @rtype: L{ExperimenterGroupWrapper}\n \"\"\"\n \n admin_serv = self.getAdminService()\n dgr = admin_serv.getDefaultGroup(long(eid))\n return ExperimenterGroupWrapper(self, dgr)\n \n def getOtherGroups(self, eid):\n \"\"\" \n Fetch all groups of which the given user is a member. \n The returned groups will have all fields filled in and all collections unloaded.\n \n @param eid: Experimenter ID\n @type eid: Long\n @return: Generator of groups for user\n @rtype: L{ExperimenterGroupWrapper} generator\n \"\"\"\n \n admin_serv = self.getAdminService()\n for gr in admin_serv.containedGroups(long(eid)):\n yield ExperimenterGroupWrapper(self, gr)\n \n def getGroupsLeaderOf(self):\n \"\"\" \n Look up Groups where current user is a leader of.\n \n @return: Groups that current user leads\n @rtype: L{ExperimenterGroupWrapper} generator\n \"\"\"\n \n q = self.getQueryService()\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"ids\"] = rlist([rlong(a) for a in self.getEventContext().leaderOfGroups])\n sql = \"select e from ExperimenterGroup as e where e.id in (:ids)\"\n for e in q.findAllByQuery(sql, p,self.SERVICE_OPTS):\n yield ExperimenterGroupWrapper(self, e)\n\n def getGroupsMemberOf(self):\n \"\"\" \n Look up Groups where current user is a member of (except \"user\" group).\n \n @return: Current users groups\n @rtype: L{ExperimenterGroupWrapper} generator\n \"\"\"\n \n q = self.getQueryService()\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"ids\"] = rlist([rlong(a) for a in self.getEventContext().memberOfGroups])\n sql = \"select e from ExperimenterGroup as e where e.id in (:ids)\"\n for e in q.findAllByQuery(sql, p,self.SERVICE_OPTS):\n if e.name.val == \"user\":\n pass\n else:\n yield ExperimenterGroupWrapper(self, e)\n\n\n def createGroup(self, name, owner_Ids=None, member_Ids=None, perms=None, description=None):\n \"\"\"\n Creates a new ExperimenterGroup. Must have Admin permissions to call this.\n \n @param name: New group name\n @param owner_Ids: Option to add existing Experimenters as group owners\n @param member_Ids: Option to add existing Experimenters as group members\n @param perms: New group permissions. E.g. 'rw----' (private), 'rwr---'(read-only), 'rwrw--'\n @param description: Group description\n \"\"\"\n admin_serv = self.getAdminService()\n\n group = omero.model.ExperimenterGroupI()\n group.name = rstring(str(name))\n group.description = (description!=\"\" and description is not None) and rstring(str(description)) or None\n if perms is not None:\n group.details.permissions = omero.model.PermissionsI(perms)\n\n gr_id = admin_serv.createGroup(group)\n\n if owner_Ids is not None:\n group_owners = [owner._obj for owner in self.getObjects(\"Experimenter\", owner_Ids)]\n admin_serv.addGroupOwners(omero.model.ExperimenterGroupI(gr_id, False), group_owners)\n\n if member_Ids is not None:\n group_members = [member._obj for member in self.getObjects(\"Experimenter\", member_Ids)]\n for user in group_members:\n admin_serv.addGroups(user, [omero.model.ExperimenterGroupI(gr_id, False)])\n\n return gr_id\n\n # EXPERIMENTERS\n\n def findExperimenters (self, start=''):\n \"\"\"\n Return a generator for all Experimenters whose omeName starts with 'start'.\n Experimenters ordered by omeName.\n \n @param start: omeName must start with these letters\n @type start: String\n @return: Generator of experimenters\n @rtype: L{ExperimenterWrapper} generator\n \"\"\"\n \n if isinstance(start, UnicodeType):\n start = start.encode('utf8')\n params = omero.sys.Parameters()\n params.map = {'start': rstring('%s%%' % start.lower())}\n q = self.getQueryService()\n rv = q.findAllByQuery(\"from Experimenter e where lower(e.omeName) like :start\", params,self.SERVICE_OPTS)\n rv.sort(lambda x,y: cmp(x.omeName.val,y.omeName.val))\n for e in rv:\n yield ExperimenterWrapper(self, e)\n\n def containedExperimenters(self, gid):\n \"\"\" \n Fetch all users contained in this group. \n The returned users will have all fields filled in and all collections unloaded.\n \n @param gid: Group ID\n @type gid: Long\n @return: Generator of experimenters\n @rtype: L{ExperimenterWrapper} generator\n \"\"\"\n \n admin_serv = self.getAdminService()\n for exp in admin_serv.containedExperimenters(long(gid)):\n yield ExperimenterWrapper(self, exp)\n \n def listColleagues(self):\n \"\"\"\n Look up users who are a member of the current user active group.\n Returns None if the group is private and isn't lead by the current user\n \n @return: Generator of Experimenters or None\n @rtype: L{ExperimenterWrapper} generator\n \"\"\"\n \n default = self.getObject(\"ExperimenterGroup\", self.getEventContext().groupId)\n if not default.isPrivate() or self.isLeader():\n for d in default.copyGroupExperimenterMap():\n if d is None:\n continue\n if d.child.id.val != self.getUserId():\n yield ExperimenterWrapper(self, d.child)\n\n def groupSummary(self, gid=None, exclude_self=False):\n \"\"\"\n Returns lists of 'leaders' and 'members' of the specified group (default is current group)\n as a dict with those keys.\n\n @return: {'leaders': list L{ExperimenterWrapper}, 'colleagues': list L{ExperimenterWrapper}}\n @rtype: dict\n \"\"\"\n\n if gid is None:\n gid = self.getEventContext().groupId\n userId = None\n if exclude_self:\n userId = self.getUserId()\n colleagues = []\n leaders = []\n default = self.getObject(\"ExperimenterGroup\", gid)\n if not default.isPrivate() or self.isLeader() or self.isAdmin():\n for d in default.copyGroupExperimenterMap():\n if d is None or d.child.id.val == userId:\n continue\n if d.owner.val:\n leaders.append(ExperimenterWrapper(self, d.child))\n else:\n colleagues.append(ExperimenterWrapper(self, d.child))\n else:\n if self.isLeader():\n leaders = [self.getUser()]\n else:\n colleagues = [self.getUser()]\n return {\"leaders\": leaders, \"colleagues\": colleagues}\n\n def listStaffs(self):\n \"\"\"\n Look up users who are members of groups lead by the current user.\n \n @return: Members of groups lead by current user\n @rtype: L{ExperimenterWrapper} generator\n \"\"\"\n \n q = self.getQueryService()\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"gids\"] = rlist([rlong(a) for a in set(self.getEventContext().leaderOfGroups)])\n sql = \"select e from Experimenter as e where \" \\\n \"exists ( select gem from GroupExperimenterMap as gem where gem.child = e.id \" \\\n \"and gem.parent.id in (:gids)) order by e.omeName\"\n for e in q.findAllByQuery(sql, p,self.SERVICE_OPTS):\n if e.id.val != self.getUserId():\n yield ExperimenterWrapper(self, e)\n\n def listOwnedGroups(self):\n \"\"\"\n Looks up owned groups for the logged user.\n \n @return: Groups owned by current user\n @rtype: L{ExperimenterGroupWrapper} generator\n \"\"\"\n \n exp = self.getUser()\n for gem in exp.copyGroupExperimenterMap():\n if gem is None:\n continue\n if gem.owner.val:\n yield ExperimenterGroupWrapper(self, gem.parent)\n \n def getFreeSpace(self):\n \"\"\" \n Returns the free or available space on this file system\n including nested subdirectories.\n \n @return: Free space in bytes\n @rtype: Int\n \"\"\"\n \n rep_serv = self.getRepositoryInfoService()\n return rep_serv.getFreeSpaceInKilobytes() * 1024\n \n ############################\n # Timeline service getters #\n\n def timelineListImages (self, tfrom=None, tto=None, limit=10, only_owned=True):\n \"\"\"\n List images based on their creation times.\n If both tfrom and tto are None, grab the most recent batch.\n \n @param tfrom: milliseconds since the epoch for start date\n @param tto: milliseconds since the epoch for end date\n @param limit: maximum number of results\n @param only_owned: Only owned by the logged user. Boolean.\n @return: Generator yielding _ImageWrapper\n @rtype: L{ImageWrapper} generator\n \"\"\"\n \n tm = self.getTimelineService()\n p = omero.sys.Parameters()\n f = omero.sys.Filter()\n if only_owned:\n f.ownerId = rlong(self.getEventContext().userId)\n f.groupId = rlong(self.getEventContext().groupId)\n else:\n f.ownerId = rlong(-1)\n f.groupId = None\n f.limit = rint(limit)\n p.theFilter = f\n if tfrom is None and tto is None:\n for e in tm.getMostRecentObjects(['Image'], p, False)[\"Image\"]:\n yield ImageWrapper(self, e)\n else:\n if tfrom is None:\n tfrom = 0\n if tto is None:\n tto = time.time() * 1000\n for e in tm.getByPeriod(['Image'], rtime(long(tfrom)), rtime(long(tto)), p, False)['Image']:\n yield ImageWrapper(self, e)\n\n\n ###########################\n # Specific Object Getters #\n\n def getObject (self, obj_type, oid=None, params=None, attributes=None):\n \"\"\"\n Retrieve single Object by type E.g. \"Image\" or None if not found.\n If more than one object found, raises ome.conditions.ApiUsageException\n See L{getObjects} for more info.\n\n @param obj_type: Object type. E.g. \"Project\" see above\n @type obj_type: String\n @param ids: object IDs\n @type ids: List of Long\n @param params: omero.sys.Parameters, can be used for pagination, filtering etc.\n @param attributes: Map of key-value pairs to filter results by. Key must be attribute of obj_type. E.g. 'name', 'ns'\n @return:\n \"\"\"\n oids = (oid!=None) and [oid] or None\n query, params, wrapper = self.buildQuery(obj_type, oids, params, attributes)\n result = self.getQueryService().findByQuery(query, params, self.SERVICE_OPTS)\n if result is not None:\n return wrapper(self, result)\n\n def getObjects (self, obj_type, ids=None, params=None, attributes=None):\n \"\"\"\n Retrieve Objects by type E.g. \"Image\"\n Returns generator of appropriate L{BlitzObjectWrapper} type. E.g. L{ImageWrapper}.\n If ids is None, all available objects will be returned. i.e. listObjects()\n Filter objects by attributes. E.g. attributes={'name':name}\n\n @param obj_type: Object type. E.g. \"Project\" see above\n @type obj_type: String\n @param ids: object IDs\n @type ids: List of Long\n @param params: omero.sys.Parameters, can be used for pagination, filtering etc.\n @param attributes: Map of key-value pairs to filter results by. Key must be attribute of obj_type. E.g. 'name', 'ns'\n @return: Generator of L{BlitzObjectWrapper} subclasses\n \"\"\"\n query, params, wrapper = self.buildQuery(obj_type, ids, params, attributes)\n result = self.getQueryService().findAllByQuery(query, params, self.SERVICE_OPTS)\n for r in result:\n yield wrapper(self, r)\n\n def buildQuery (self, obj_type, ids=None, params=None, attributes=None):\n \"\"\"\n Prepares a query for iQuery. Also prepares params and determines appropriate wrapper for result\n Returns (query, params, wrapper) which can be used with the appropriate query method.\n Used by L{getObjects} and L{getObject} above.\n\n @param obj_type: Object type. E.g. \"Project\" see above\n @type obj_type: String\n @param ids: object IDs\n @type ids: List of Long\n @param params: omero.sys.Parameters, can be used for pagination, filtering etc.\n @param attributes: Map of key-value pairs to filter results by. Key must be attribute of obj_type. E.g. 'name', 'ns'\n @return: (query, params, wrapper)\n \"\"\"\n\n if type(obj_type) is type(''):\n wrapper = KNOWN_WRAPPERS.get(obj_type.lower(), None)\n if wrapper is None:\n raise KeyError(\"obj_type of %s not supported by getOjbects(). E.g. use 'Image' etc\" % obj_type)\n else:\n raise AttributeError(\"getObjects uses a string to define obj_type, E.g. 'Image'\")\n\n q = self.getQueryService()\n if params is None:\n params = omero.sys.Parameters()\n if params.map is None:\n params.map = {}\n\n # get the base query from the instantiated object itself. E.g \"select obj Project as obj\"\n query = wrapper()._getQueryString()\n\n clauses = []\n # getting object by ids\n if ids != None:\n clauses.append(\"obj.id in (:ids)\")\n params.map[\"ids\"] = rlist([rlong(a) for a in ids])\n\n # support filtering by owner (not for some object types)\n if params.theFilter and params.theFilter.ownerId and obj_type.lower() not in [\"experimentergroup\", \"experimenter\"]:\n clauses.append(\"owner.id = (:eid)\")\n params.map[\"eid\"] = params.theFilter.ownerId\n\n # finding by attributes\n if attributes != None:\n for k,v in attributes.items():\n clauses.append('obj.%s=:%s' % (k, k) )\n params.map[k] = omero_type(v)\n\n if clauses:\n query += \" where \" + (\" and \".join(clauses))\n\n return (query, params, wrapper)\n\n\n def listFileAnnotations (self, eid=None, toInclude=[], toExclude=[]):\n \"\"\"\n Lists FileAnnotations created by users, filtering by namespaces if specified.\n If NO namespaces are specified, then 'known' namespaces are excluded by default,\n such as original files and companion files etc.\n File objects are loaded so E.g. file name is available without lazy loading.\n\n @param eid: Filter results by this owner Id\n @param toInclude: Only return annotations with these namespaces. List of strings.\n @param toExclude: Don't return annotations with these namespaces. List of strings.\n @return: Generator of L{FileAnnotationWrapper}s - with files loaded.\n \"\"\"\n\n params = omero.sys.Parameters()\n params.theFilter = omero.sys.Filter()\n if eid is not None:\n params.theFilter.ownerId = rlong(eid)\n\n if len(toInclude) == 0 and len(toExclude) == 0:\n toExclude.append(omero.constants.namespaces.NSCOMPANIONFILE)\n toExclude.append(omero.constants.annotation.file.ORIGINALMETADATA)\n toExclude.append(omero.constants.namespaces.NSEXPERIMENTERPHOTO)\n toExclude.append(omero.constants.analysis.flim.NSFLIM)\n\n anns = self.getMetadataService().loadSpecifiedAnnotations(\"FileAnnotation\", toInclude, toExclude, params, self.SERVICE_OPTS)\n\n for a in anns:\n yield(FileAnnotationWrapper(self, a))\n\n\n def getAnnotationLinks (self, parent_type, parent_ids=None, ann_ids=None, ns=None, params=None):\n \"\"\"\n Retrieve Annotation Links by parent_type E.g. \"Image\". Not Ordered. \n Returns generator of L{AnnotationLinkWrapper}\n If parent_ids is None, all available objects will be returned. i.e. listObjects()\n\n @param obj_type: Object type. E.g. \"Project\" see above\n @type obj_type: String\n @param ids: object IDs\n @type ids: List of Long\n @return: Generator yielding wrapped objects.\n \"\"\"\n\n if parent_type.lower() not in KNOWN_WRAPPERS:\n wrapper_types = \", \".join(KNOWN_WRAPPERS.keys())\n err_msg = \"getAnnotationLinks() does not support type: '%s'. Must be one of: %s\" % (parent_type, wrapper_types)\n raise AttributeError(err_msg)\n wrapper = KNOWN_WRAPPERS.get(parent_type.lower(), None)\n class_string = wrapper().OMERO_CLASS\n if class_string is None and \"annotation\" in parent_type.lower(): # E.g. AnnotationWrappers have no OMERO_CLASS\n class_string = \"Annotation\"\n\n query = \"select annLink from %sAnnotationLink as annLink join fetch annLink.details.owner as owner \" \\\n \"join fetch annLink.details.creationEvent \" \\\n \"join fetch annLink.child as ann join fetch ann.details.owner join fetch ann.details.creationEvent \"\\\n \"join fetch annLink.parent as parent\" % class_string\n\n q = self.getQueryService()\n if params is None:\n params = omero.sys.Parameters()\n if params.map is None:\n params.map = {}\n\n clauses = []\n if parent_ids:\n clauses.append(\"parent.id in (:pids)\")\n params.map[\"pids\"] = rlist([rlong(a) for a in parent_ids])\n\n if ann_ids:\n clauses.append(\"ann.id in (:ann_ids)\")\n params.map[\"ann_ids\"] = rlist([rlong(a) for a in ann_ids])\n\n if ns:\n clauses.append(\"ann.ns in (:ns)\")\n params.map[\"ns\"] = rstring(ns)\n\n if params.theFilter and params.theFilter.ownerId:\n clauses.append(\"owner.id = (:eid)\")\n params.map[\"eid\"] = params.theFilter.ownerId\n\n if len(clauses) > 0:\n query += \" where %s\" % (\" and \".join(clauses))\n\n result = q.findAllByQuery(query, params,self.SERVICE_OPTS)\n for r in result:\n yield AnnotationLinkWrapper(self, r)\n\n\n def createImageFromNumpySeq (self, zctPlanes, imageName, sizeZ=1, sizeC=1, sizeT=1, description=None, dataset=None):\n \"\"\"\n Creates a new multi-dimensional image from the sequence of 2D numpy arrays in zctPlanes.\n zctPlanes should be a generator of numpy 2D arrays of shape (sizeY, sizeX) ordered\n to iterate through T first, then C then Z.\n Example usage:\n original = conn.getObject(\"Image\", 1)\n sizeZ = original.getSizeZ()\n sizeC = original.getSizeC()\n sizeT = original.getSizeT()\n zctList = []\n for z in range(sizeZ):\n for c in range(sizeC):\n for t in range(sizeT):\n zctList.append( (z,c,t) )\n def planeGen():\n planes = original.getPrimaryPixels().getPlanes(zctList)\n for p in planes:\n # perform some manipulation on each plane\n yield p\n createImageFromNumpySeq (planeGen(), imageName, sizeZ=sizeZ, sizeC=sizeC, sizeT=sizeT\n\n @param session An OMERO service factory or equivalent with getQueryService() etc.\n @param zctPlanes A generator of numpy 2D arrays, corresponding to Z-planes of new image.\n @param imageName Name of new image\n @param description Description for the new image\n @param dataset If specified, put the image in this dataset. omero.model.Dataset object\n\n @return The new OMERO image: omero.model.ImageI\n \"\"\"\n queryService = self.getQueryService()\n pixelsService = self.getPixelsService()\n rawPixelsStore = self.c.sf.createRawPixelsStore() # Make sure we don't get an existing rpStore\n #renderingEngine = self.createRenderingEngine()\n containerService = self.getContainerService()\n updateService = self.getUpdateService()\n\n def createImage(firstPlane):\n \"\"\" Create our new Image once we have the first plane in hand \"\"\"\n # need to map numpy pixel types to omero - don't handle: bool_, character, int_, int64, object_\n pTypes = {'int8':'int8', 'int16':'int16', 'uint16':'uint16', 'int32':'int32', 'float_':'float', 'float8':'float', \n 'float16':'float', 'float32':'float', 'float64':'double', 'complex_':'complex', 'complex64':'complex'}\n dType = firstPlane.dtype.name\n if dType not in pTypes: # try to look up any not named above\n pType = dType\n else:\n pType = pTypes[dType]\n pixelsType = queryService.findByQuery(\"from PixelsType as p where p.value='%s'\" % pType, None) # omero::model::PixelsType\n if pixelsType is None:\n raise Exception(\"Cannot create an image in omero from numpy array with dtype: %s\" % dType)\n sizeY, sizeX = firstPlane.shape\n channelList = range(1, sizeC+1)\n iId = pixelsService.createImage(sizeX, sizeY, sizeZ, sizeT, channelList, pixelsType, imageName, description)\n imageId = iId.getValue()\n return containerService.getImages(\"Image\", [imageId], None)[0]\n\n def uploadPlane(plane, z, c, t):\n byteSwappedPlane = plane.byteswap();\n convertedPlane = byteSwappedPlane.tostring();\n rawPixelsStore.setPlane(convertedPlane, z, c, t)\n\n image = None\n channelsMinMax = []\n exc = None\n try:\n for theZ in range(sizeZ):\n for theC in range(sizeC):\n for theT in range(sizeT):\n plane = zctPlanes.next()\n if image == None: # use the first plane to create image.\n image = createImage(plane)\n pixelsId = image.getPrimaryPixels().getId().getValue()\n rawPixelsStore.setPixelsId(pixelsId, True, self.SERVICE_OPTS)\n uploadPlane(plane, theZ, theC, theT)\n # init or update min and max for this channel\n minValue = plane.min()\n maxValue = plane.max()\n if len(channelsMinMax) < (theC +1): # first plane of each channel\n channelsMinMax.append( [minValue, maxValue] )\n else:\n channelsMinMax[theC][0] = min(channelsMinMax[theC][0], minValue)\n channelsMinMax[theC][1] = max(channelsMinMax[theC][1], maxValue)\n except Exception, e:\n logger.error(\"Failed to setPlane() on rawPixelsStore while creating Image\", exc_info=True)\n exc = e\n try:\n rawPixelsStore.close()\n except Exception, e:\n logger.error(\"Failed to close rawPixelsStore\", exc_info=True)\n if exc is None:\n exc = e\n if exc is not None:\n raise exc\n\n try: # simply completing the generator - to avoid a GeneratorExit error.\n zctPlanes.next()\n except StopIteration:\n pass\n\n for theC, mm in enumerate(channelsMinMax):\n pixelsService.setChannelGlobalMinMax(pixelsId, theC, float(mm[0]), float(mm[1]))\n #resetRenderingSettings(renderingEngine, pixelsId, theC, mm[0], mm[1])\n\n # put the image in dataset, if specified.\n if dataset:\n link = omero.model.DatasetImageLinkI()\n link.parent = omero.model.DatasetI(dataset.getId(), False)\n link.child = omero.model.ImageI(image.id.val, False)\n updateService.saveObject(link)\n\n return ImageWrapper(self, image)\n\n def createOriginalFileFromFileObj (self, fo, path, name, fileSize, mimetype=None, ns=None):\n \"\"\"\n Creates a L{OriginalFileWrapper} from a local file.\n File is uploaded to create an omero.model.OriginalFileI.\n Returns a new L{OriginalFileWrapper}\n\n @param conn: Blitz connection\n @param fo: The file object\n @param path: The file path\n @param name: The file name\n @param fileSize: The file size\n @param mimetype: The mimetype of the file. String. E.g. 'text/plain'\n @param ns: The file namespace\n @return: New L{OriginalFileWrapper}\n \"\"\"\n updateService = self.getUpdateService()\n rawFileStore = self.createRawFileStore()\n\n # create original file, set name, path, mimetype\n originalFile = omero.model.OriginalFileI()\n originalFile.setName(rstring(name))\n originalFile.setPath(rstring(path))\n if mimetype:\n originalFile.mimetype = rstring(mimetype)\n originalFile.setSize(rlong(fileSize))\n # set sha1\n try:\n import hashlib\n hash_sha1 = hashlib.sha1\n except:\n import sha\n hash_sha1 = sha.new\n fo.seek(0)\n h = hash_sha1()\n h.update(fo.read())\n shaHast = h.hexdigest()\n originalFile.setSha1(rstring(shaHast))\n originalFile = updateService.saveAndReturnObject(originalFile)\n\n # upload file\n fo.seek(0)\n rawFileStore.setFileId(originalFile.getId().getValue())\n buf = 10000\n for pos in range(0,long(fileSize),buf):\n block = None\n if fileSize-pos < buf:\n blockSize = fileSize-pos\n else:\n blockSize = buf\n fo.seek(pos)\n block = fo.read(blockSize)\n rawFileStore.write(block, pos, blockSize)\n return OriginalFileWrapper(self, originalFile)\n \n def createOriginalFileFromLocalFile (self, localPath, origFilePathAndName=None, mimetype=None, ns=None):\n \"\"\"\n Creates a L{OriginalFileWrapper} from a local file.\n File is uploaded to create an omero.model.OriginalFileI.\n Returns a new L{OriginalFileWrapper}\n\n @param conn: Blitz connection\n @param localPath: Location to find the local file to upload\n @param origFilePathAndName: Provides the 'path' and 'name' of the OriginalFile. If None, use localPath\n @param mimetype: The mimetype of the file. String. E.g. 'text/plain'\n @param ns: The namespace of the file.\n @return: New L{OriginalFileWrapper}\n \"\"\"\n if origFilePathAndName is None:\n origFilePathAndName = localPath\n path, name = os.path.split(origFilePathAndName)\n fileSize = os.path.getsize(localPath)\n fileHandle = open(localPath, 'rb')\n try:\n return self.createOriginalFileFromFileObj (fileHandle, path, name, fileSize, mimetype, ns)\n finally:\n fileHandle.close()\n\n def createFileAnnfromLocalFile (self, localPath, origFilePathAndName=None, mimetype=None, ns=None, desc=None):\n \"\"\"\n Class method to create a L{FileAnnotationWrapper} from a local file.\n File is uploaded to create an omero.model.OriginalFileI referenced from this File Annotation.\n Returns a new L{FileAnnotationWrapper}\n\n @param conn: Blitz connection\n @param localPath: Location to find the local file to upload\n @param origFilePathAndName: Provides the 'path' and 'name' of the OriginalFile. If None, use localPath\n @param mimetype: The mimetype of the file. String. E.g. 'text/plain'\n @param ns: The namespace of the file.\n @param desc: A description for the file annotation.\n @return: New L{FileAnnotationWrapper}\n \"\"\"\n updateService = self.getUpdateService()\n\n # create and upload original file\n originalFile = self.createOriginalFileFromLocalFile(localPath, origFilePathAndName, mimetype, ns)\n \n # create FileAnnotation, set ns & description and return wrapped obj\n fa = omero.model.FileAnnotationI()\n fa.setFile(originalFile._obj)\n if desc:\n fa.setDescription(rstring(desc))\n if ns:\n fa.setNs(rstring(ns))\n fa = updateService.saveAndReturnObject(fa)\n return FileAnnotationWrapper(self, fa)\n\n def getObjectsByAnnotations(self, obj_type, annids):\n \"\"\"\n Retrieve objects linked to the given annotation IDs\n controlled by the security system.\n \n @param annids: Annotation IDs\n @type annids: L{Long}\n @return: Generator yielding Objects\n @rtype: L{BlitzObjectWrapper} generator\n \"\"\"\n \n wrapper = KNOWN_WRAPPERS.get(obj_type.lower(), None)\n if not wrapper:\n raise AttributeError(\"Don't know how to handle '%s'\" % obj_type)\n \n sql = \"select ob from %s ob \" \\\n \"left outer join fetch ob.annotationLinks obal \" \\\n \"left outer join fetch obal.child ann \" \\\n \"where ann.id in (:oids)\" % wrapper().OMERO_CLASS\n \n q = self.getQueryService()\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"oids\"] = rlist([rlong(o) for o in set(annids)])\n for e in q.findAllByQuery(sql,p,self.SERVICE_OPTS):\n kwargs = {'link': BlitzObjectWrapper(self, e.copyAnnotationLinks()[0])}\n yield wrapper(self, e)\n\n\n ################\n # Enumerations #\n \n def getEnumerationEntries(self, klass):\n \"\"\"\n Get all enumerations by class\n \n @param klass: Class\n @type klass: Class or string\n @return: Generator of Enumerations\n @rtype: L{EnumerationWrapper} generator\n \"\"\"\n \n types = self.getTypesService()\n for e in types.allEnumerations(str(klass)):\n yield EnumerationWrapper(self, e)\n \n def getEnumeration(self, klass, string):\n \"\"\"\n Get enumeration by class and value\n \n @param klass: Class\n @type klass: Class or string\n @param string: Enum value\n @type string: String\n @return: Enumeration or None\n @rtype: L{EnumerationWrapper}\n \"\"\"\n \n types = self.getTypesService()\n obj = types.getEnumeration(str(klass), str(string))\n if obj is not None:\n return EnumerationWrapper(self, obj)\n else:\n return None\n \n def getEnumerationById(self, klass, eid):\n \"\"\"\n Get enumeration by class and ID\n \n @param klass: Class\n @type klass: Class or string\n @param eid: Enum ID\n @type eid: Long\n @return: Enumeration or None\n @rtype: L{EnumerationWrapper}\n \"\"\"\n \n query_serv = self.getQueryService()\n obj = query_serv.find(klass, long(eid), self.SERVICE_OPTS)\n if obj is not None:\n return EnumerationWrapper(self, obj)\n else:\n return None\n \n def getOriginalEnumerations(self):\n \"\"\"\n Gets original enumerations. Returns a dictionary of enumeration class: list of Enumerations\n \n @return: Original enums\n @rtype: Dict of <string: L{EnumerationWrapper} list >\n \"\"\"\n \n types = self.getTypesService()\n rv = dict()\n for e in types.getOriginalEnumerations():\n if rv.get(e.__class__.__name__) is None:\n rv[e.__class__.__name__] = list()\n rv[e.__class__.__name__].append(EnumerationWrapper(self, e))\n return rv\n \n def getEnumerations(self):\n \"\"\"\n Gets list of enumeration types\n \n @return: List of enum types\n @rtype: List of Strings\n \"\"\"\n \n types = self.getTypesService()\n return types.getEnumerationTypes() \n \n def getEnumerationsWithEntries(self):\n \"\"\"\n Get enumeration types, with lists of Enum entries\n \n @return: Dictionary of type: entries\n @rtype: Dict of <string: L{EnumerationWrapper} list >\n \"\"\"\n \n types = self.getTypesService()\n rv = dict()\n for key, value in types.getEnumerationsWithEntries().items():\n r = list()\n for e in value:\n r.append(EnumerationWrapper(self, e))\n rv[key+\"I\"] = r\n return rv\n \n def deleteEnumeration(self, obj):\n \"\"\"\n Deletes an enumeration object\n \n @param obj: Enumeration object\n @type obj: omero.model.IObject\n \"\"\"\n \n types = self.getTypesService()\n types.deleteEnumeration(obj)\n \n def createEnumeration(self, obj):\n \"\"\"\n Create an enumeration with given object \n \n @param obj: Object\n @type obj: omero.model.IObject\n \"\"\"\n \n types = self.getTypesService()\n types.createEnumeration(obj)\n \n def resetEnumerations(self, klass):\n \"\"\"\n Resets the enumerations by type\n \n @param klass: Type of enum to reset\n @type klass: String\n \"\"\"\n \n types = self.getTypesService()\n types.resetEnumerations(klass)\n \n def updateEnumerations(self, new_entries):\n \"\"\"\n Updates enumerations with new entries\n \n @param new_entries: List of objects\n @type new_entries: List of omero.model.IObject\n \"\"\"\n \n types = self.getTypesService()\n types.updateEnumerations(new_entries)\n \n ###################\n # Delete #\n \n def deleteObjectDirect(self, obj):\n \"\"\"\n Directly Delete object (removes row from database).\n This may fail with various constraint violations if the object is linked to others in the database\n \n @param obj: Object to delete\n @type obj: IObject\"\"\"\n \n u = self.getUpdateService() \n u.deleteObject(obj, self.SERVICE_OPTS)\n\n def getAvailableDeleteCommands(self):\n \"\"\"\n Retrieves the current set of delete commands with type (graph spec)\n and options filled.\n @return: Exhaustive list of available delete commands.\n @rtype: L{omero.api.delete.DeleteCommand}\n \"\"\"\n return self.getDeleteService().availableCommands()\n\n def deleteObjects(self, graph_spec, obj_ids, deleteAnns=False,\n deleteChildren=False):\n \"\"\"\n Generic method for deleting using the delete queue. Options allow to\n delete 'independent' Annotations (Tag, Term, File) and to delete\n child objects.\n\n @param graph_spec: String to indicate the object type or graph\n specification. Examples include:\n * 'Project'\n * 'Dataset'\n * 'Image'\n * 'Screen'\n * 'Plate'\n * 'Well'\n * 'Annotation'\n * '/OriginalFile'\n * '/Image+Only'\n * '/Image/Pixels/Channel'\n As of OMERO 4.4.0 the correct case is now\n explicitly required, the use of 'project'\n or 'dataset' is no longer supported.\n @param obj_ids: List of IDs for the objects to delete\n @param deleteAnns: If true, delete linked Tag, Term and File\n annotations\n @param deleteChildren: If true, delete children. E.g. Delete Project\n AND it's Datasets & Images.\n @return: Delete handle\n @rtype: L{omero.api.delete.DeleteHandle}\n \"\"\"\n\n if not isinstance(obj_ids, list) and len(obj_ids) < 1:\n raise AttributeError('Must be a list of object IDs')\n\n if not graph_spec.startswith('/'):\n graph_spec = '/%s' % graph_spec\n logger.debug('Received object type, using \"%s\"' % graph_spec)\n\n op = dict()\n if not deleteAnns and graph_spec not in [\"/Annotation\",\n \"/TagAnnotation\"]:\n op[\"/TagAnnotation\"] = \"KEEP\"\n op[\"/TermAnnotation\"] = \"KEEP\"\n op[\"/FileAnnotation\"] = \"KEEP\"\n\n childTypes = {'/Project':['/Dataset', '/Image'],\n '/Dataset':['/Image'],\n '/Image':[],\n '/Screen':['/Plate'],\n '/Plate':['/Image'],\n '/Well':[],\n '/Annotation':[] }\n\n if not deleteChildren:\n try:\n for c in childTypes[graph_spec]:\n op[c] = \"KEEP\"\n except KeyError:\n pass\n\n dcs = list()\n logger.debug('Deleting %s [%s]. Options: %s' % \\\n (graph_spec, str(obj_ids), op))\n for oid in obj_ids:\n dcs.append(omero.cmd.Delete(\n graph_spec, long(oid), op))\n doall = omero.cmd.DoAll()\n doall.requests = dcs\n handle = self.c.sf.submit(doall, self.SERVICE_OPTS)\n return handle\n\n def _waitOnCmd(self, handle, loops=10, ms=500, failonerror=True):\n callback = omero.callbacks.CmdCallbackI(self.c, handle)\n callback.loop(loops, ms) # Throw LockTimeout\n rsp = callback.getResponse()\n if isinstance(rsp, omero.cmd.ERR):\n if failonerror:\n raise Exception(rsp) # ???\n return callback\n\n def chmodGroup(self, group_Id, permissions):\n \"\"\"\n Change the permissions of a particluar Group.\n Returns the proxy 'prx' handle that can be processed like this:\n callback = CmdCallbackI(self.gateway.c, prx)\n callback.loop(20, 500)\n rsp = prx.getResponse()\n \"\"\"\n chmod = omero.cmd.Chmod(type=\"/ExperimenterGroup\", id=group_Id, permissions=permissions)\n prx = self.c.sf.submit(chmod)\n return prx\n\n\n def chgrpObjects(self, graph_spec, obj_ids, group_id, container_id=None):\n \"\"\"\n Change the Group for a specified objects using queue.\n\n @param graph_spec: String to indicate the object type or graph\n specification. Examples include:\n * '/Image'\n * '/Project' # will move contents too.\n * NB: Also supports 'Image' etc for convenience\n @param obj_ids: IDs for the objects to move.\n @param group_id: The group to move the data to.\n \"\"\"\n\n if not graph_spec.startswith('/'):\n graph_spec = '/%s' % graph_spec\n logger.debug('chgrp Received object type, using \"%s\"' % graph_spec)\n\n # (link, child, parent)\n parentLinkClasses = {\"/Image\": (omero.model.DatasetImageLinkI, omero.model.ImageI, omero.model.DatasetI),\n \"/Dataset\": (omero.model.ProjectDatasetLinkI, omero.model.DatasetI, omero.model.ProjectI),\n \"/Plate\": (omero.model.ScreenPlateLinkI, omero.model.PlateI, omero.model.ScreenI)}\n da = DoAll()\n requests = []\n for obj_id in obj_ids:\n obj_id = long(obj_id)\n logger.debug('DoAll Chgrp: type: %s, id: %s, grp: %s' % (graph_spec, obj_id, group_id))\n chgrp = omero.cmd.Chgrp(type=graph_spec, id=obj_id, options=None, grp=group_id)\n requests.append(chgrp)\n if container_id is not None and graph_spec in parentLinkClasses:\n # get link class for graph_spec objects\n link_klass = parentLinkClasses[graph_spec][0]\n link = link_klass()\n link.child = parentLinkClasses[graph_spec][1](obj_id, False)\n link.parent = parentLinkClasses[graph_spec][2](container_id, False)\n save = Save()\n save.obj = link\n requests.append(save)\n\n da.requests = requests\n ctx = self.SERVICE_OPTS.copy()\n ctx.setOmeroGroup(group_id) # NB: For Save to work, we need to be in target group\n prx = self.c.sf.submit(da, ctx)\n return prx\n\n\n ###################\n # Searching stuff #\n\n def searchObjects(self, obj_types, text, created=None):\n \"\"\"\n Search objects of type \"Project\", \"Dataset\", \"Image\", \"Screen\", \"Plate\"\n Returns a list of results\n \n @param obj_types: E.g. [\"Dataset\", \"Image\"]\n @param text: The text to search for\n @param created: L{omero.rtime} list or tuple (start, stop)\n @return: List of Object wrappers. E.g. L{ImageWrapper}\n \"\"\"\n if not text:\n return []\n if isinstance(text, UnicodeType):\n text = text.encode('utf8')\n if obj_types is None:\n types = (ProjectWrapper, DatasetWrapper, ImageWrapper)\n else:\n def getWrapper(obj_type):\n if obj_type.lower() not in [\"project\", \"dataset\", \"image\", \"screen\", \"plate\", \"well\"]:\n raise AttributeError(\"%s not recognised. Can only search for 'Project', 'Dataset', 'Image', 'Screen', 'Plate', 'Well'\" % obj_type)\n return KNOWN_WRAPPERS.get(obj_type.lower(), None)\n types = [getWrapper(o) for o in obj_types]\n search = self.createSearchService()\n try:\n if created:\n search.onlyCreatedBetween(created[0], created[1]);\n if text[0] in ('?','*'):\n search.setAllowLeadingWildcard(True)\n rv = []\n for t in types:\n def actualSearch ():\n search.onlyType(t().OMERO_CLASS, self.SERVICE_OPTS)\n search.byFullText(text, self.SERVICE_OPTS)\n timeit(actualSearch)()\n if search.hasNext(self.SERVICE_OPTS):\n def searchProcessing ():\n rv.extend(map(lambda x: t(self, x), search.results()))\n timeit(searchProcessing)()\n finally:\n search.close()\n return rv\n\n\nclass OmeroGatewaySafeCallWrapper(object): #pragma: no cover\n \"\"\"\n Function or method wrapper that handles certain types of server side\n exceptions and debugging of errors.\n \"\"\"\n\n def __init__(self, proxyObjectWrapper, attr, f):\n \"\"\"\n Initialises the function call wrapper.\n\n @param attr: Function name\n @type attr: String\n @param f: Function to wrap\n @type f: Function\n \"\"\"\n self.proxyObjectWrapper = proxyObjectWrapper\n self.attr = attr\n self.f = f\n try:\n self.__f__name = f.im_self.ice_getIdentity().name\n except:\n self.__f__name = \"unknown\"\n\n def debug(self, exc_class, args, kwargs):\n logger.warn(\"%s on %s to <%s> %s(%r, %r)\",\n exc_class, self.__class__, self.__f__name, self.attr,\n args, kwargs, exc_info=True)\n\n def handle_exception(self, e, *args, **kwargs):\n \"\"\"\n Exception handler that is expected to be overridden by sub-classes.\n The expected behaviour is either to handle a type of exception and\n return the server side result or to raise the already thrown\n exception. The calling context is an except block and the original\n *args and **kwargs from the wrapped function or method are provided\n to allow re-execution of the original.\n\n @param e: The exception that has already been raised.\n @type e: Exception\n \"\"\"\n raise\n\n def __call__(self, *args, **kwargs):\n try:\n return self.f(*args, **kwargs)\n except Exception, e:\n self.debug(e.__class__.__name__, args, kwargs)\n return self.handle_exception(e, *args, **kwargs)\n\n# Extension point for API users who want to customise the semantics of\n# safe call wrap. (See #6365)\n#\n# Since: OMERO Beta-4.3.2 (Tue 2 Aug 2011 09:59:47 BST)\nSafeCallWrapper = OmeroGatewaySafeCallWrapper\n\nBlitzGateway = _BlitzGateway\n\n\ndef splitHTMLColor (color):\n \"\"\" splits an hex stream of characters into an array of bytes in format (R,G,B,A).\n - abc -> (0xAA, 0xBB, 0xCC, 0xFF)\n - abcd -> (0xAA, 0xBB, 0xCC, 0xDD)\n - abbccd -> (0xAB, 0xBC, 0xCD, 0xFF)\n - abbccdde -> (0xAB, 0xBC, 0xCD, 0xDE)\n \n @param color: Characters to split.\n @return: rgba\n @rtype: list of Ints\n \"\"\"\n try:\n out = []\n if len(color) in (3,4):\n c = color\n color = ''\n for e in c:\n color += e + e\n if len(color) == 6:\n color += 'FF'\n if len(color) == 8:\n for i in range(0, 8, 2):\n out.append(int(color[i:i+2], 16))\n return out\n except:\n pass\n return None\n\n\nclass ProxyObjectWrapper (object):\n \"\"\"\n Wrapper for services. E.g. Admin Service, Delete Service etc. \n Maintains reference to connection. \n Handles creation of service when requested. \n \"\"\"\n \n def __init__ (self, conn, func_str, cast_to=None, service_name=None):\n \"\"\"\n Initialisation of proxy object wrapper. \n \n @param conn: The L{BlitzGateway} connection\n @type conn: L{BlitzGateway}\n @param func_str: The name of the service creation method. E.g 'getAdminService'\n @type func_str: String\n @param cast_to: the checkedCast function to call with service name (only if func_str is None)\n @type cast_to: function\n @param service_name: Service name to use with cast_to (only if func_str is None)\n \n \"\"\"\n self._obj = None\n self._func_str = func_str\n self._cast_to = cast_to\n self._service_name = service_name\n self._resyncConn(conn)\n self._tainted = False\n \n def clone (self):\n \"\"\"\n Creates and returns a new L{ProxyObjectWrapper} with the same connection \n and service creation method name as this one. \n \n @return: Cloned service wrapper\n @rtype: L{ProxyObjectWrapper}\n \"\"\"\n \n return ProxyObjectWrapper(self._conn, self._func_str, self._cast_to, self._service_name)\n\n def _connect (self, forcejoin=False): #pragma: no cover\n \"\"\"\n Returns True if connected. If connection OK, wrapped service is also created. \n\n @param forcejoin: if True forces the connection to only succeed if we can\n rejoin the current sessionid\n @type forcejoin: Boolean\n \n @return: True if connection OK\n @rtype: Boolean\n \"\"\"\n logger.debug(\"proxy_connect: a\");\n if forcejoin:\n sUuid = self._conn._sessionUuid\n else:\n sUuid = None\n if not self._conn.connect(sUuid=sUuid):\n logger.debug('connect failed')\n logger.debug('/n'.join(traceback.format_stack()))\n return False\n logger.debug(\"proxy_connect: b\");\n self._resyncConn(self._conn)\n logger.debug(\"proxy_connect: c\");\n self._obj = self._create_func()\n logger.debug(\"proxy_connect: d\");\n return True\n\n def taint (self):\n \"\"\" Sets the tainted flag to True \"\"\"\n self._tainted = True\n\n def untaint (self):\n \"\"\" Sets the tainted flag to False \"\"\"\n self._tainted = False\n\n def close (self):\n \"\"\"\n Closes the underlaying service, so next call to the proxy will create a new\n instance of it.\n \"\"\"\n \n if self._obj and isinstance(self._obj, omero.api.StatefulServiceInterfacePrx):\n self._obj.close()\n self._obj = None\n \n def _resyncConn (self, conn):\n \"\"\"\n Reset refs to connection and session factory. Resets session creation function. \n Attempts to reload the wrapped service - if already created (doesn't create service)\n \n @param conn: Connection\n @type conn: L{BlitzGateway}\n \"\"\"\n \n self._conn = conn\n self._sf = conn.c.sf\n def cf ():\n if self._func_str is None:\n return self._cast_to(self._sf.getByName(self._service_name))\n else:\n return getattr(self._sf, self._func_str)()\n self._create_func = cf\n if self._obj is not None:\n try:\n logger.debug(\"## - refreshing %s\" % (self._func_str or self._service_name))\n obj = conn.c.ic.stringToProxy(str(self._obj))\n self._obj = self._obj.checkedCast(obj)\n except Ice.ObjectNotExistException:\n self._obj = None\n\n def _getObj (self):\n \"\"\"\n Returns the wrapped service. If it is None, service is created. \n \n @return: The wrapped service\n @rtype: omero.api.ServiceInterface subclass\n \"\"\"\n \n if not self._obj:\n try:\n self._obj = self._create_func()\n except Ice.ConnectionLostException:\n logger.debug('... lost, reconnecting (_getObj)')\n self._connect()\n #self._obj = self._create_func()\n else:\n self._ping()\n return self._obj\n\n def _ping (self): #pragma: no cover\n \"\"\"\n For some reason, it seems that keepAlive doesn't, so every so often I need to recreate the objects.\n Calls serviceFactory.keepAlive(service). If this returns false, attempt to create service. \n \n @return: True if no exception thrown \n @rtype: Boolean\n \"\"\"\n \n try:\n if not self._sf.keepAlive(self._obj):\n logger.debug(\"... died, recreating ...\")\n self._obj = self._create_func()\n except Ice.ObjectNotExistException:\n # The connection is there, but it has been reset, because the proxy no longer exists...\n logger.debug(\"... reset, reconnecting\")\n self._connect()\n return False\n except Ice.ConnectionLostException:\n # The connection was lost. This shouldn't happen, as we keep pinging it, but does so...\n logger.debug(traceback.format_stack())\n logger.debug(\"... lost, reconnecting (_ping)\")\n self._conn._connected = False\n self._connect()\n return False\n except Ice.ConnectionRefusedException:\n # The connection was refused. We lost contact with glacier2router...\n logger.debug(traceback.format_stack())\n logger.debug(\"... refused, reconnecting\")\n self._connect()\n return False\n except omero.RemovedSessionException:\n # Session died on us\n logger.debug(traceback.format_stack())\n logger.debug(\"... session has left the building, reconnecting\")\n self._connect()\n return False\n except Ice.UnknownException:\n # Probably a wrapped RemovedSession\n logger.debug(traceback.format_stack())\n logger.debug(\"... ice says something bad happened, reconnecting\")\n self._connect()\n return False\n return True\n\n def __getattr__ (self, attr):\n \"\"\"\n Returns named attribute of the wrapped service. \n If attribute is a method, the method is wrapped to handle exceptions, connection etc.\n \n @param attr: Attribute name\n @type attr: String\n @return: Attribute or wrapped method\n \"\"\"\n # safe call wrapper\n obj = self._obj or self._getObj()\n rv = getattr(obj, attr)\n if callable(rv):\n rv = SafeCallWrapper(self, attr, rv)\n #self._conn.updateTimeout()\n return rv\n\nclass AnnotationWrapper (BlitzObjectWrapper):\n \"\"\"\n omero_model_AnnotationI class wrapper extends BlitzObjectWrapper.\n \"\"\"\n registry = {} # class dict for type:wrapper E.g. DoubleAnnotationI : DoubleAnnotationWrapper\n OMERO_TYPE = None\n\n def __init__ (self, *args, **kwargs):\n \"\"\"\n Initialises the Annotation wrapper and 'link' if in kwargs\n \"\"\"\n super(AnnotationWrapper, self).__init__(*args, **kwargs)\n self.link = kwargs.has_key('link') and kwargs['link'] or None\n if self._obj is None and self.OMERO_TYPE is not None:\n self._obj = self.OMERO_TYPE()\n\n def __eq__ (self, a):\n \"\"\"\n Returns true if type, id, value and ns are equal\n \n @param a: The annotation to compare\n @return: True if annotations are the same - see above\n @rtype: Boolean\n \"\"\"\n return type(a) == type(self) and self._obj.id == a._obj.id and self.getValue() == a.getValue() and self.getNs() == a.getNs()\n\n def _getQueryString(self):\n \"\"\"\n Used for building queries in generic methods such as getObjects(\"Annotation\")\n \"\"\"\n return \"select obj from Annotation obj join fetch obj.details.owner as owner join fetch obj.details.group \"\\\n \"join fetch obj.details.creationEvent\"\n \n @classmethod\n def _register (klass, regklass):\n \"\"\"\n Adds the AnnotationWrapper regklass to class registry\n @param regklass: The wrapper class, E.g. L{DoubleAnnotationWrapper} \n @type regklass: L{AnnotationWrapper} subclass\n \"\"\"\n \n klass.registry[regklass.OMERO_TYPE] = regklass\n\n @classmethod\n def _wrap (klass, conn=None, obj=None, link=None):\n \"\"\"\n Class method for creating L{AnnotationWrapper} subclasses based on the type of \n annotation object, using previously registered mapping between OMERO types and wrapper classes\n \n @param conn: The L{BlitzGateway} connection\n @type conn: L{BlitzGateway}\n @param obj: The OMERO annotation object. E.g. omero.model.DoubleAnnotation\n @type obj: L{omero.model.Annotation} subclass\n @param link: The link for this annotation\n @type link: E.g. omero.model.DatasetAnnotationLink\n @return: Wrapped AnnotationWrapper object or None if obj.__class__ not registered\n @rtype: L{AnnotationWrapper} subclass\n \"\"\"\n if obj is None:\n return AnnotationWrapper()\n if obj.__class__ in klass.registry:\n kwargs = dict()\n if link is not None:\n kwargs['link'] = BlitzObjectWrapper(conn, link)\n return klass.registry[obj.__class__](conn, obj, **kwargs)\n else: #pragma: no cover\n return None\n\n @classmethod\n def createAndLink (klass, target, ns, val=None):\n \"\"\"\n Class method for creating an instance of this AnnotationWrapper, setting ns and value\n and linking to the target. \n \n @param target: The object to link annotation to\n @type target: L{BlitzObjectWrapper} subclass\n @param ns: Annotation namespace\n @type ns: String\n @param val: Value of annotation. E.g Long, Text, Boolean etc. \n \"\"\"\n \n this = klass()\n this.setNs(ns)\n if val is not None:\n this.setValue(val)\n target.linkAnnotation(this)\n\n def getNs (self):\n \"\"\"\n Gets annotation namespace\n \n @return: Namespace or None\n @rtype: String\n \"\"\"\n \n return self._obj.ns is not None and self._obj.ns.val or None\n\n def setNs (self, val):\n \"\"\"\n Sets annotation namespace\n \n @param val: Namespace value\n @type val: String\n \"\"\"\n \n self._obj.ns = omero_type(val)\n \n def getValue (self): #pragma: no cover\n \"\"\" Needs to be implemented by subclasses \"\"\"\n raise NotImplementedError\n\n def setValue (self, val): #pragma: no cover\n \"\"\" Needs to be implemented by subclasses \"\"\"\n raise NotImplementedError\n \n def getParentLinks(self, ptype, pids=None): \n ptype = ptype.lower()\n if not ptype in ('project', 'dataset', 'image', 'screen', 'plate', 'well'):\n AttributeError('Annotation can be linked only to: project, dataset, image, screen, plate, well')\n p = omero.sys.Parameters()\n p.map = {}\n p.map[\"aid\"] = rlong(self.id)\n sql = \"select oal from %sAnnotationLink as oal left outer join fetch oal.child as ch \" \\\n \"left outer join fetch oal.parent as pa \" \\\n \"where ch.id=:aid \" % (ptype.title())\n if pids is not None:\n p.map[\"pids\"] = rlist([rlong(ob) for ob in pids])\n sql+=\" and pa.id in (:pids)\" \n \n for al in self._conn.getQueryService().findAllByQuery(sql, p, self._conn.SERVICE_OPTS):\n yield AnnotationLinkWrapper(self._conn, al)\n\nclass _AnnotationLinkWrapper (BlitzObjectWrapper):\n \"\"\"\n omero_model_AnnotationLinkI class wrapper extends omero.gateway.BlitzObjectWrapper.\n \"\"\"\n\n def getAnnotation(self):\n return AnnotationWrapper._wrap(self._conn, self.child, self._obj)\n\nAnnotationLinkWrapper = _AnnotationLinkWrapper\n \nfrom omero_model_FileAnnotationI import FileAnnotationI\n\nclass FileAnnotationWrapper (AnnotationWrapper):\n \"\"\"\n omero_model_FileAnnotatio class wrapper extends AnnotationWrapper.\n \"\"\"\n\n OMERO_TYPE = FileAnnotationI\n\n _attrs = ('file|OriginalFileWrapper',)\n \n def _getQueryString(self):\n \"\"\"\n Used for building queries in generic methods such as getObjects(\"FileAnnotation\")\n \"\"\"\n return \"select obj from FileAnnotation obj join fetch obj.details.owner as owner join fetch obj.details.group \"\\\n \"join fetch obj.details.creationEvent join fetch obj.file\"\n\n def getValue (self):\n \"\"\" Not implemented \"\"\"\n pass\n\n def setValue (self, val):\n \"\"\" Not implemented \"\"\"\n pass\n\n def setFile (self, originalfile):\n \"\"\"\n \"\"\"\n self._obj.file = omero.model.OriginalFileI(originalfile.getId(), False)\n\n def setDescription (self, val):\n \"\"\"\n \"\"\"\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227998,"cells":{"text":{"kind":"string","value":"# -*- coding: utf-8 -*-\n##############################################################################\n#\n# OpenERP, Open Source Management Solution\n# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).\n#\n# This program is free software: you can redistribute it and/or modify\n# it under the terms of the GNU Affero General Public License as\n# published by the Free Software Foundation, either version 3 of the\n# License, or (at your option) any later version.\n#\n# This program is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU Affero General Public License for more details.\n#\n# You should have received a copy of the GNU Affero General Public License\n# along with this program. If not, see <http://www.gnu.org/licenses/>.\n#\n##############################################################################\n\n\"\"\" Fields:\n - simple\n - relations (one2many, many2one, many2many)\n - function\n\n Fields Attributes:\n * _classic_read: is a classic sql fields\n * _type : field type\n * _auto_join: for one2many and many2one fields, tells whether select\n queries will join the relational table instead of replacing the\n field condition by an equivalent-one based on a search.\n * readonly\n * required\n * size\n\"\"\"\n\nimport base64\nimport datetime as DT\nimport functools\nimport logging\nimport pytz\nimport re\nimport xmlrpclib\nfrom operator import itemgetter\nfrom contextlib import contextmanager\nfrom psycopg2 import Binary\n\nimport openerp\nimport openerp.tools as tools\nfrom openerp.tools.translate import _\nfrom openerp.tools import float_repr, float_round, frozendict, html_sanitize\nimport simplejson\nfrom openerp import SUPERUSER_ID, registry\n\n@contextmanager\ndef _get_cursor():\n # yield a valid cursor from any environment or create a new one if none found\n with registry().cursor() as cr:\n yield cr\n\nEMPTY_DICT = frozendict()\n\n_logger = logging.getLogger(__name__)\n\ndef _symbol_set(symb):\n if symb is None or symb == False:\n return None\n elif isinstance(symb, unicode):\n return symb.encode('utf-8')\n return str(symb)\n\n\nclass _column(object):\n \"\"\" Base of all fields, a database column\n\n An instance of this object is a *description* of a database column. It will\n not hold any data, but only provide the methods to manipulate data of an\n ORM record or even prepare/update the database to hold such a field of data.\n \"\"\"\n _classic_read = True\n _classic_write = True\n _auto_join = False\n _properties = False\n _type = 'unknown'\n _obj = None\n _multi = False\n _symbol_c = '%s'\n _symbol_f = _symbol_set\n _symbol_set = (_symbol_c, _symbol_f)\n _symbol_get = None\n _deprecated = False\n\n __slots__ = [\n 'copy', # whether value is copied by BaseModel.copy()\n 'string',\n 'help',\n 'required',\n 'readonly',\n '_domain',\n '_context',\n 'states',\n 'priority',\n 'change_default',\n 'size',\n 'ondelete',\n 'translate',\n 'select',\n 'manual',\n 'write',\n 'read',\n 'selectable',\n 'group_operator',\n 'groups', # CSV list of ext IDs of groups\n 'deprecated', # Optional deprecation warning\n '_args',\n '_prefetch',\n ]\n\n def __init__(self, string='unknown', required=False, readonly=False, domain=[], context={}, states=None, priority=0, change_default=False, size=None, ondelete=None, translate=False, select=False, manual=False, **args):\n \"\"\"\n\n The 'manual' keyword argument specifies if the field is a custom one.\n It corresponds to the 'state' column in ir_model_fields.\n\n \"\"\"\n # add parameters and default values\n args['copy'] = args.get('copy', True)\n args['string'] = string\n args['help'] = args.get('help', '')\n args['required'] = required\n args['readonly'] = readonly\n args['_domain'] = domain\n args['_context'] = context\n args['states'] = states\n args['priority'] = priority\n args['change_default'] = change_default\n args['size'] = size\n args['ondelete'] = ondelete.lower() if ondelete else None\n args['translate'] = translate\n args['select'] = select\n args['manual'] = manual\n args['write'] = args.get('write', False)\n args['read'] = args.get('read', False)\n args['selectable'] = args.get('selectable', True)\n args['group_operator'] = args.get('group_operator', None)\n args['groups'] = args.get('groups', None)\n args['deprecated'] = args.get('deprecated', None)\n args['_prefetch'] = args.get('_prefetch', True)\n\n self._args = EMPTY_DICT\n for key, val in args.iteritems():\n setattr(self, key, val)\n\n # prefetch only if _classic_write, not deprecated and not manual\n if not self._classic_write or self.deprecated or self.manual:\n self._prefetch = False\n\n def __getattr__(self, name):\n \"\"\" Access a non-slot attribute. \"\"\"\n if name == '_args':\n raise AttributeError(name)\n try:\n return self._args[name]\n except KeyError:\n raise AttributeError(name)\n\n def __setattr__(self, name, value):\n \"\"\" Set a slot or non-slot attribute. \"\"\"\n try:\n object.__setattr__(self, name, value)\n except AttributeError:\n if self._args:\n self._args[name] = value\n else:\n self._args = {name: value} # replace EMPTY_DICT\n\n def __delattr__(self, name):\n \"\"\" Remove a non-slot attribute. \"\"\"\n try:\n del self._args[name]\n except KeyError:\n raise AttributeError(name)\n\n def new(self, _computed_field=False, **args):\n \"\"\" Return a column like `self` with the given parameters; the parameter\n `_computed_field` tells whether the corresponding field is computed.\n \"\"\"\n # memory optimization: reuse self whenever possible; you can reduce the\n # average memory usage per registry by 10 megabytes!\n column = type(self)(**args)\n return self if self.to_field_args() == column.to_field_args() else column\n\n def to_field(self):\n \"\"\" convert column `self` to a new-style field \"\"\"\n from openerp.fields import Field\n return Field.by_type[self._type](column=self, **self.to_field_args())\n\n def to_field_args(self):\n \"\"\" return a dictionary with all the arguments to pass to the field \"\"\"\n base_items = [\n ('copy', self.copy),\n ('index', self.select),\n ('manual', self.manual),\n ('string', self.string),\n ('help', self.help),\n ('readonly', self.readonly),\n ('required', self.required),\n ('states', self.states),\n ('groups', self.groups),\n ('change_default', self.change_default),\n ('deprecated', self.deprecated),\n ]\n truthy_items = filter(itemgetter(1), [\n ('group_operator', self.group_operator),\n ('size', self.size),\n ('ondelete', self.ondelete),\n ('translate', self.translate),\n ('domain', self._domain),\n ('context', self._context),\n ])\n return dict(base_items + truthy_items + self._args.items())\n\n def restart(self):\n pass\n\n def set(self, cr, obj, id, name, value, user=None, context=None):\n cr.execute('update '+obj._table+' set '+name+'='+self._symbol_set[0]+' where id=%s', (self._symbol_set[1](value), id))\n\n def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):\n raise Exception(_('undefined get method !'))\n\n def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):\n ids = obj.search(cr, uid, args+self._domain+[(name, 'ilike', value)], offset, limit, context=context)\n res = obj.read(cr, uid, ids, [name], context=context)\n return [x[name] for x in res]\n\n def as_display_name(self, cr, uid, obj, value, context=None):\n \"\"\"Converts a field value to a suitable string representation for a record,\n e.g. when this field is used as ``rec_name``.\n\n :param obj: the ``BaseModel`` instance this column belongs to \n :param value: a proper value as returned by :py:meth:`~openerp.orm.osv.BaseModel.read`\n for this column\n \"\"\"\n # delegated to class method, so a column type A can delegate\n # to a column type B. \n return self._as_display_name(self, cr, uid, obj, value, context=None)\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n # This needs to be a class method, in case a column type A as to delegate\n # to a column type B.\n return tools.ustr(value)\n\n# ---------------------------------------------------------\n# Simple fields\n# ---------------------------------------------------------\nclass boolean(_column):\n _type = 'boolean'\n _symbol_c = '%s'\n _symbol_f = bool\n _symbol_set = (_symbol_c, _symbol_f)\n __slots__ = []\n\n def __init__(self, string='unknown', required=False, **args):\n super(boolean, self).__init__(string=string, required=required, **args)\n if required:\n _logger.debug(\n \"required=True is deprecated: making a boolean field\"\n \" `required` has no effect, as NULL values are \"\n \"automatically turned into False. args: %r\",args)\n\nclass integer(_column):\n _type = 'integer'\n _symbol_c = '%s'\n _symbol_f = lambda x: int(x or 0)\n _symbol_set = (_symbol_c, _symbol_f)\n _symbol_get = lambda self,x: x or 0\n __slots__ = []\n\n def __init__(self, string='unknown', required=False, **args):\n super(integer, self).__init__(string=string, required=required, **args)\n\nclass reference(_column):\n _type = 'reference'\n _classic_read = False # post-process to handle missing target\n __slots__ = ['selection']\n\n def __init__(self, string, selection, size=None, **args):\n if callable(selection):\n from openerp import api\n selection = api.expected(api.cr_uid_context, selection)\n _column.__init__(self, string=string, size=size, selection=selection, **args)\n\n def to_field_args(self):\n args = super(reference, self).to_field_args()\n args['selection'] = self.selection\n return args\n\n def get(self, cr, obj, ids, name, uid=None, context=None, values=None):\n result = {}\n # copy initial values fetched previously.\n for value in values:\n result[value['id']] = value[name]\n if value[name]:\n model, res_id = value[name].split(',')\n if not obj.pool[model].exists(cr, uid, [int(res_id)], context=context):\n result[value['id']] = False\n return result\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n if value:\n # reference fields have a 'model,id'-like value, that we need to convert\n # to a real name\n model_name, res_id = value.split(',')\n if model_name in obj.pool and res_id:\n model = obj.pool[model_name]\n names = model.name_get(cr, uid, [int(res_id)], context=context)\n return names[0][1] if names else False\n return tools.ustr(value)\n\n# takes a string (encoded in utf8) and returns a string (encoded in utf8)\ndef _symbol_set_char(self, symb):\n\n #TODO:\n # * we need to remove the \"symb==False\" from the next line BUT\n # for now too many things rely on this broken behavior\n # * the symb==None test should be common to all data types\n if symb is None or symb == False:\n return None\n\n # we need to convert the string to a unicode object to be able\n # to evaluate its length (and possibly truncate it) reliably\n u_symb = tools.ustr(symb)\n return u_symb[:self.size].encode('utf8')\n\nclass char(_column):\n _type = 'char'\n __slots__ = ['_symbol_f', '_symbol_set', '_symbol_set_char']\n\n def __init__(self, string=\"unknown\", size=None, **args):\n _column.__init__(self, string=string, size=size or None, **args)\n # self._symbol_set_char defined to keep the backward compatibility\n self._symbol_f = self._symbol_set_char = lambda x: _symbol_set_char(self, x)\n self._symbol_set = (self._symbol_c, self._symbol_f)\n\nclass text(_column):\n _type = 'text'\n __slots__ = []\n\n\nclass html(text):\n _type = 'html'\n _symbol_c = '%s'\n __slots__ = ['_sanitize', '_strip_style', '_symbol_f', '_symbol_set']\n\n def _symbol_set_html(self, value):\n if value is None or value is False:\n return None\n if not self._sanitize:\n return value\n return html_sanitize(value, strip_style=self._strip_style)\n\n def __init__(self, string='unknown', sanitize=True, strip_style=False, **args):\n super(html, self).__init__(string=string, **args)\n self._sanitize = sanitize\n self._strip_style = strip_style\n # symbol_set redefinition because of sanitize specific behavior\n self._symbol_f = self._symbol_set_html\n self._symbol_set = (self._symbol_c, self._symbol_f)\n\n def to_field_args(self):\n args = super(html, self).to_field_args()\n args['sanitize'] = self._sanitize\n args['strip_style'] = self._strip_style\n return args\n\nimport __builtin__\n\ndef _symbol_set_float(self, x):\n result = __builtin__.float(x or 0.0)\n digits = self.digits\n if digits:\n precision, scale = digits\n result = float_repr(float_round(result, precision_digits=scale), precision_digits=scale)\n return result\n\nclass float(_column):\n _type = 'float'\n _symbol_c = '%s'\n _symbol_get = lambda self,x: x or 0.0\n __slots__ = ['_digits', '_digits_compute', '_symbol_f', '_symbol_set']\n\n @property\n def digits(self):\n if self._digits_compute:\n with _get_cursor() as cr:\n return self._digits_compute(cr)\n else:\n return self._digits\n\n def __init__(self, string='unknown', digits=None, digits_compute=None, required=False, **args):\n _column.__init__(self, string=string, required=required, **args)\n # synopsis: digits_compute(cr) -> (precision, scale)\n self._digits = digits\n self._digits_compute = digits_compute\n self._symbol_f = lambda x: _symbol_set_float(self, x)\n self._symbol_set = (self._symbol_c, self._symbol_f)\n\n def to_field_args(self):\n args = super(float, self).to_field_args()\n args['digits'] = self._digits_compute or self._digits\n return args\n\n def digits_change(self, cr):\n pass\n\nclass date(_column):\n _type = 'date'\n __slots__ = []\n\n MONTHS = [\n ('01', 'January'),\n ('02', 'February'),\n ('03', 'March'),\n ('04', 'April'),\n ('05', 'May'),\n ('06', 'June'),\n ('07', 'July'),\n ('08', 'August'),\n ('09', 'September'),\n ('10', 'October'),\n ('11', 'November'),\n ('12', 'December')\n ]\n\n @staticmethod\n def today(*args):\n \"\"\" Returns the current date in a format fit for being a\n default value to a ``date`` field.\n\n This method should be provided as is to the _defaults dict, it\n should not be called.\n \"\"\"\n return DT.date.today().strftime(\n tools.DEFAULT_SERVER_DATE_FORMAT)\n\n @staticmethod\n def context_today(model, cr, uid, context=None, timestamp=None):\n \"\"\"Returns the current date as seen in the client's timezone\n in a format fit for date fields.\n This method may be passed as value to initialize _defaults.\n\n :param Model model: model (osv) for which the date value is being\n computed - automatically passed when used in\n _defaults.\n :param datetime timestamp: optional datetime value to use instead of\n the current date and time (must be a\n datetime, regular dates can't be converted\n between timezones.)\n :param dict context: the 'tz' key in the context should give the\n name of the User/Client timezone (otherwise\n UTC is used)\n :rtype: str \n \"\"\"\n today = timestamp or DT.datetime.now()\n context_today = None\n if context and context.get('tz'):\n tz_name = context['tz'] \n else:\n user = model.pool['res.users'].browse(cr, SUPERUSER_ID, uid)\n tz_name = user.tz\n if tz_name:\n try:\n utc = pytz.timezone('UTC')\n context_tz = pytz.timezone(tz_name)\n utc_today = utc.localize(today, is_dst=False) # UTC = no DST\n context_today = utc_today.astimezone(context_tz)\n except Exception:\n _logger.debug(\"failed to compute context/client-specific today date, \"\n \"using the UTC value for `today`\",\n exc_info=True)\n return (context_today or today).strftime(tools.DEFAULT_SERVER_DATE_FORMAT)\n\n @staticmethod\n def date_to_datetime(model, cr, uid, userdate, context=None):\n \"\"\" Convert date values expressed in user's timezone to\n server-side UTC timestamp, assuming a default arbitrary\n time of 12:00 AM - because a time is needed.\n\n :param str userdate: date string in in user time zone\n :return: UTC datetime string for server-side use\n \"\"\"\n user_date = DT.datetime.strptime(userdate, tools.DEFAULT_SERVER_DATE_FORMAT)\n if context and context.get('tz'):\n tz_name = context['tz']\n else:\n tz_name = model.pool.get('res.users').read(cr, SUPERUSER_ID, uid, ['tz'])['tz']\n if tz_name:\n utc = pytz.timezone('UTC')\n context_tz = pytz.timezone(tz_name)\n user_datetime = user_date + DT.timedelta(hours=12.0)\n local_timestamp = context_tz.localize(user_datetime, is_dst=False)\n user_datetime = local_timestamp.astimezone(utc)\n return user_datetime.strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)\n return user_date.strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT)\n\n\nclass datetime(_column):\n _type = 'datetime'\n __slots__ = []\n\n MONTHS = [\n ('01', 'January'),\n ('02', 'February'),\n ('03', 'March'),\n ('04', 'April'),\n ('05', 'May'),\n ('06', 'June'),\n ('07', 'July'),\n ('08', 'August'),\n ('09', 'September'),\n ('10', 'October'),\n ('11', 'November'),\n ('12', 'December')\n ]\n\n @staticmethod\n def now(*args):\n \"\"\" Returns the current datetime in a format fit for being a\n default value to a ``datetime`` field.\n\n This method should be provided as is to the _defaults dict, it\n should not be called.\n \"\"\"\n return DT.datetime.now().strftime(\n tools.DEFAULT_SERVER_DATETIME_FORMAT)\n\n @staticmethod\n def context_timestamp(cr, uid, timestamp, context=None):\n \"\"\"Returns the given timestamp converted to the client's timezone.\n This method is *not* meant for use as a _defaults initializer,\n because datetime fields are automatically converted upon\n display on client side. For _defaults you :meth:`fields.datetime.now`\n should be used instead.\n\n :param datetime timestamp: naive datetime value (expressed in UTC)\n to be converted to the client timezone\n :param dict context: the 'tz' key in the context should give the\n name of the User/Client timezone (otherwise\n UTC is used)\n :rtype: datetime\n :return: timestamp converted to timezone-aware datetime in context\n timezone\n \"\"\"\n assert isinstance(timestamp, DT.datetime), 'Datetime instance expected'\n if context and context.get('tz'):\n tz_name = context['tz'] \n else:\n registry = openerp.modules.registry.RegistryManager.get(cr.dbname)\n user = registry['res.users'].browse(cr, SUPERUSER_ID, uid)\n tz_name = user.tz\n utc_timestamp = pytz.utc.localize(timestamp, is_dst=False) # UTC = no DST\n if tz_name:\n try:\n context_tz = pytz.timezone(tz_name)\n return utc_timestamp.astimezone(context_tz)\n except Exception:\n _logger.debug(\"failed to compute context/client-specific timestamp, \"\n \"using the UTC value\",\n exc_info=True)\n return utc_timestamp\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n value = datetime.context_timestamp(cr, uid, DT.datetime.strptime(value, tools.DEFAULT_SERVER_DATETIME_FORMAT), context=context)\n return tools.ustr(value.strftime(tools.DEFAULT_SERVER_DATETIME_FORMAT))\n\nclass binary(_column):\n _type = 'binary'\n _classic_read = False\n\n # Binary values may be byte strings (python 2.6 byte array), but\n # the legacy OpenERP convention is to transfer and store binaries\n # as base64-encoded strings. The base64 string may be provided as a\n # unicode in some circumstances, hence the str() cast in symbol_f.\n # This str coercion will only work for pure ASCII unicode strings,\n # on purpose - non base64 data must be passed as a 8bit byte strings.\n _symbol_c = '%s'\n _symbol_f = lambda symb: symb and Binary(str(symb)) or None\n _symbol_set = (_symbol_c, _symbol_f)\n _symbol_get = lambda self, x: x and str(x)\n\n __slots__ = ['filters']\n\n def __init__(self, string='unknown', filters=None, **args):\n args['_prefetch'] = args.get('_prefetch', False)\n _column.__init__(self, string=string, filters=filters, **args)\n\n def get(self, cr, obj, ids, name, user=None, context=None, values=None):\n if not context:\n context = {}\n if not values:\n values = []\n res = {}\n for i in ids:\n val = None\n for v in values:\n if v['id'] == i:\n val = v[name]\n break\n\n # If client is requesting only the size of the field, we return it instead\n # of the content. Presumably a separate request will be done to read the actual\n # content if it's needed at some point.\n # TODO: after 6.0 we should consider returning a dict with size and content instead of\n # having an implicit convention for the value\n if val and context.get('bin_size_%s' % name, context.get('bin_size')):\n res[i] = tools.human_size(long(val))\n else:\n res[i] = val\n return res\n\nclass selection(_column):\n _type = 'selection'\n __slots__ = ['selection']\n\n def __init__(self, selection, string='unknown', **args):\n if callable(selection):\n from openerp import api\n selection = api.expected(api.cr_uid_context, selection)\n _column.__init__(self, string=string, selection=selection, **args)\n\n def to_field_args(self):\n args = super(selection, self).to_field_args()\n args['selection'] = self.selection\n return args\n\n @classmethod\n def reify(cls, cr, uid, model, field, context=None):\n \"\"\" Munges the field's ``selection`` attribute as necessary to get\n something useable out of it: calls it if it's a function, applies\n translations to labels if it's not.\n\n A callable ``selection`` is considered translated on its own.\n\n :param orm.Model model:\n :param _column field:\n \"\"\"\n if callable(field.selection):\n return field.selection(model, cr, uid, context)\n\n if not (context and 'lang' in context):\n return field.selection\n\n # field_to_dict isn't given a field name, only a field object, we\n # need to get the name back in order to perform the translation lookup\n field_name = next(\n name for name, column in model._columns.iteritems()\n if column == field)\n\n translation_filter = \"%s,%s\" % (model._name, field_name)\n translate = functools.partial(\n model.pool['ir.translation']._get_source,\n cr, uid, translation_filter, 'selection', context['lang'])\n\n return [\n (value, translate(label))\n for value, label in field.selection\n ]\n\n# ---------------------------------------------------------\n# Relationals fields\n# ---------------------------------------------------------\n\n#\n# Values: (0, 0, { fields }) create\n# (1, ID, { fields }) update\n# (2, ID) remove (delete)\n# (3, ID) unlink one (target id or target of relation)\n# (4, ID) link\n# (5) unlink all (only valid for one2many)\n#\n\nclass many2one(_column):\n _classic_read = False\n _classic_write = True\n _type = 'many2one'\n _symbol_c = '%s'\n _symbol_f = lambda x: x or None\n _symbol_set = (_symbol_c, _symbol_f)\n\n __slots__ = ['_obj', '_auto_join']\n\n def __init__(self, obj, string='unknown', auto_join=False, **args):\n args['ondelete'] = args.get('ondelete', 'set null')\n _column.__init__(self, string=string, **args)\n self._obj = obj\n self._auto_join = auto_join\n\n def to_field_args(self):\n args = super(many2one, self).to_field_args()\n args['comodel_name'] = self._obj\n args['auto_join'] = self._auto_join\n return args\n\n def set(self, cr, obj_src, id, field, values, user=None, context=None):\n if not context:\n context = {}\n obj = obj_src.pool[self._obj]\n self._table = obj._table\n if type(values) == type([]):\n for act in values:\n if act[0] == 0:\n id_new = obj.create(cr, act[2])\n cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (id_new, id))\n elif act[0] == 1:\n obj.write(cr, [act[1]], act[2], context=context)\n elif act[0] == 2:\n cr.execute('delete from '+self._table+' where id=%s', (act[1],))\n elif act[0] == 3 or act[0] == 5:\n cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))\n elif act[0] == 4:\n cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (act[1], id))\n else:\n if values:\n cr.execute('update '+obj_src._table+' set '+field+'=%s where id=%s', (values, id))\n else:\n cr.execute('update '+obj_src._table+' set '+field+'=null where id=%s', (id,))\n\n def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, context=None):\n return obj.pool[self._obj].search(cr, uid, args+self._domain+[('name', 'like', value)], offset, limit, context=context)\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n return value[1] if isinstance(value, tuple) else tools.ustr(value) \n\n\nclass one2many(_column):\n _classic_read = False\n _classic_write = False\n _type = 'one2many'\n\n __slots__ = ['_obj', '_fields_id', '_limit', '_auto_join']\n\n def __init__(self, obj, fields_id, string='unknown', limit=None, auto_join=False, **args):\n # one2many columns are not copied by default\n args['copy'] = args.get('copy', False)\n args['_prefetch'] = args.get('_prefetch', False)\n _column.__init__(self, string=string, **args)\n self._obj = obj\n self._fields_id = fields_id\n self._limit = limit\n self._auto_join = auto_join\n #one2many can't be used as condition for defaults\n assert(self.change_default != True)\n\n def to_field_args(self):\n args = super(one2many, self).to_field_args()\n args['comodel_name'] = self._obj\n args['inverse_name'] = self._fields_id\n args['auto_join'] = self._auto_join\n args['limit'] = self._limit\n return args\n\n def get(self, cr, obj, ids, name, user=None, offset=0, context=None, values=None):\n if self._context:\n context = dict(context or {})\n context.update(self._context)\n\n # retrieve the records in the comodel\n comodel = obj.pool[self._obj].browse(cr, user, [], context)\n inverse = self._fields_id\n domain = self._domain(obj) if callable(self._domain) else self._domain\n domain = domain + [(inverse, 'in', ids)]\n records = comodel.search(domain, limit=self._limit)\n\n result = {id: [] for id in ids}\n # read the inverse of records without prefetching other fields on them\n for record in records.with_context(prefetch_fields=False):\n # record[inverse] may be a record or an integer\n result[int(record[inverse])].append(record.id)\n\n return result\n\n def set(self, cr, obj, id, field, values, user=None, context=None):\n result = []\n context = dict(context or {})\n context.update(self._context)\n if not values:\n return\n obj = obj.pool[self._obj]\n rec = obj.browse(cr, user, [], context=context)\n with rec.env.norecompute():\n _table = obj._table\n for act in values:\n if act[0] == 0:\n act[2][self._fields_id] = id\n id_new = obj.create(cr, user, act[2], context=context)\n result += obj._store_get_values(cr, user, [id_new], act[2].keys(), context)\n elif act[0] == 1:\n obj.write(cr, user, [act[1]], act[2], context=context)\n elif act[0] == 2:\n obj.unlink(cr, user, [act[1]], context=context)\n elif act[0] == 3:\n inverse_field = obj._fields.get(self._fields_id)\n assert inverse_field, 'Trying to unlink the content of a o2m but the pointed model does not have a m2o'\n # if the model has on delete cascade, just delete the row\n if inverse_field.ondelete == \"cascade\":\n obj.unlink(cr, user, [act[1]], context=context)\n else:\n cr.execute('update '+_table+' set '+self._fields_id+'=null where id=%s', (act[1],))\n elif act[0] == 4:\n # check whether the given record is already linked\n rec = obj.browse(cr, SUPERUSER_ID, act[1], {'prefetch_fields': False})\n if int(rec[self._fields_id]) != id:\n # Must use write() to recompute parent_store structure if needed and check access rules\n obj.write(cr, user, [act[1]], {self._fields_id:id}, context=context or {})\n elif act[0] == 5:\n inverse_field = obj._fields.get(self._fields_id)\n assert inverse_field, 'Trying to unlink the content of a o2m but the pointed model does not have a m2o'\n # if the o2m has a static domain we must respect it when unlinking\n domain = self._domain(obj) if callable(self._domain) else self._domain\n extra_domain = domain or []\n ids_to_unlink = obj.search(cr, user, [(self._fields_id,'=',id)] + extra_domain, context=context)\n # If the model has cascade deletion, we delete the rows because it is the intended behavior,\n # otherwise we only nullify the reverse foreign key column.\n if inverse_field.ondelete == \"cascade\":\n obj.unlink(cr, user, ids_to_unlink, context=context)\n else:\n obj.write(cr, user, ids_to_unlink, {self._fields_id: False}, context=context)\n elif act[0] == 6:\n # Must use write() to recompute parent_store structure if needed\n obj.write(cr, user, act[2], {self._fields_id:id}, context=context or {})\n ids2 = act[2] or [0]\n cr.execute('select id from '+_table+' where '+self._fields_id+'=%s and id <> ALL (%s)', (id,ids2))\n ids3 = map(lambda x:x[0], cr.fetchall())\n obj.write(cr, user, ids3, {self._fields_id:False}, context=context or {})\n return result\n\n def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):\n domain = self._domain(obj) if callable(self._domain) else self._domain\n return obj.pool[self._obj].name_search(cr, uid, value, domain, operator, context=context,limit=limit)\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n raise NotImplementedError('One2Many columns should not be used as record name (_rec_name)') \n\n#\n# Values: (0, 0, { fields }) create\n# (1, ID, { fields }) update (write fields to ID)\n# (2, ID) remove (calls unlink on ID, that will also delete the relationship because of the ondelete)\n# (3, ID) unlink (delete the relationship between the two objects but does not delete ID)\n# (4, ID) link (add a relationship)\n# (5, ID) unlink all\n# (6, ?, ids) set a list of links\n#\nclass many2many(_column):\n \"\"\"Encapsulates the logic of a many-to-many bidirectional relationship, handling the\n low-level details of the intermediary relationship table transparently.\n A many-to-many relationship is always symmetrical, and can be declared and accessed\n from either endpoint model.\n If ``rel`` (relationship table name), ``id1`` (source foreign key column name)\n or id2 (destination foreign key column name) are not specified, the system will\n provide default values. This will by default only allow one single symmetrical\n many-to-many relationship between the source and destination model.\n For multiple many-to-many relationship between the same models and for\n relationships where source and destination models are the same, ``rel``, ``id1``\n and ``id2`` should be specified explicitly.\n\n :param str obj: destination model\n :param str rel: optional name of the intermediary relationship table. If not specified,\n a canonical name will be derived based on the alphabetically-ordered\n model names of the source and destination (in the form: ``amodel_bmodel_rel``).\n Automatic naming is not possible when the source and destination are\n the same, for obvious ambiguity reasons.\n :param str id1: optional name for the column holding the foreign key to the current\n model in the relationship table. If not specified, a canonical name\n will be derived based on the model name (in the form: `src_model_id`).\n :param str id2: optional name for the column holding the foreign key to the destination\n model in the relationship table. If not specified, a canonical name\n will be derived based on the model name (in the form: `dest_model_id`)\n :param str string: field label\n \"\"\"\n _classic_read = False\n _classic_write = False\n _type = 'many2many'\n\n __slots__ = ['_obj', '_rel', '_id1', '_id2', '_limit', '_auto_join']\n\n def __init__(self, obj, rel=None, id1=None, id2=None, string='unknown', limit=None, **args):\n \"\"\"\n \"\"\"\n args['_prefetch'] = args.get('_prefetch', False)\n _column.__init__(self, string=string, **args)\n self._obj = obj\n if rel and '.' in rel:\n raise Exception(_('The second argument of the many2many field %s must be a SQL table !'\\\n 'You used %s, which is not a valid SQL table name.')% (string,rel))\n self._rel = rel\n self._id1 = id1\n self._id2 = id2\n self._limit = limit\n self._auto_join = False\n\n def to_field_args(self):\n args = super(many2many, self).to_field_args()\n args['comodel_name'] = self._obj\n args['relation'] = self._rel\n args['column1'] = self._id1\n args['column2'] = self._id2\n args['limit'] = self._limit\n return args\n\n def _sql_names(self, source_model):\n \"\"\"Return the SQL names defining the structure of the m2m relationship table\n\n :return: (m2m_table, local_col, dest_col) where m2m_table is the table name,\n local_col is the name of the column holding the current model's FK, and\n dest_col is the name of the column holding the destination model's FK, and\n \"\"\"\n tbl, col1, col2 = self._rel, self._id1, self._id2\n if not all((tbl, col1, col2)):\n # the default table name is based on the stable alphabetical order of tables\n dest_model = source_model.pool[self._obj]\n tables = tuple(sorted([source_model._table, dest_model._table]))\n if not tbl:\n assert tables[0] != tables[1], 'Implicit/Canonical naming of m2m relationship table '\\\n 'is not possible when source and destination models are '\\\n 'the same'\n tbl = '%s_%s_rel' % tables\n if not col1:\n col1 = '%s_id' % source_model._table\n if not col2:\n col2 = '%s_id' % dest_model._table\n return tbl, col1, col2\n\n def _get_query_and_where_params(self, cr, model, ids, values, where_params):\n \"\"\" Extracted from ``get`` to facilitate fine-tuning of the generated\n query. \"\"\"\n query = 'SELECT %(rel)s.%(id2)s, %(rel)s.%(id1)s \\\n FROM %(rel)s, %(from_c)s \\\n WHERE %(rel)s.%(id1)s IN %%s \\\n AND %(rel)s.%(id2)s = %(tbl)s.id \\\n %(where_c)s \\\n %(order_by)s \\\n %(limit)s \\\n OFFSET %(offset)d' \\\n % values\n return query, where_params\n\n def get(self, cr, model, ids, name, user=None, offset=0, context=None, values=None):\n if not context:\n context = {}\n if not values:\n values = {}\n res = {}\n if not ids:\n return res\n for id in ids:\n res[id] = []\n if offset:\n _logger.warning(\n \"Specifying offset at a many2many.get() is deprecated and may\"\n \" produce unpredictable results.\")\n obj = model.pool[self._obj]\n rel, id1, id2 = self._sql_names(model)\n\n # static domains are lists, and are evaluated both here and on client-side, while string\n # domains supposed by dynamic and evaluated on client-side only (thus ignored here)\n # FIXME: make this distinction explicit in API!\n domain = isinstance(self._domain, list) and self._domain or []\n\n wquery = obj._where_calc(cr, user, domain, context=context)\n obj._apply_ir_rules(cr, user, wquery, 'read', context=context)\n order_by = obj._generate_order_by(None, wquery)\n from_c, where_c, where_params = wquery.get_sql()\n if where_c:\n where_c = ' AND ' + where_c\n\n limit_str = ''\n if self._limit is not None:\n limit_str = ' LIMIT %d' % self._limit\n\n query, where_params = self._get_query_and_where_params(cr, model, ids, {'rel': rel,\n 'from_c': from_c,\n 'tbl': obj._table,\n 'id1': id1,\n 'id2': id2,\n 'where_c': where_c,\n 'limit': limit_str,\n 'order_by': order_by,\n 'offset': offset,\n }, where_params)\n\n cr.execute(query, [tuple(ids),] + where_params)\n for r in cr.fetchall():\n res[r[1]].append(r[0])\n return res\n\n def set(self, cr, model, id, name, values, user=None, context=None):\n if not context:\n context = {}\n if not values:\n return\n rel, id1, id2 = self._sql_names(model)\n obj = model.pool[self._obj]\n\n def link(ids):\n # beware of duplicates when inserting\n query = \"\"\" INSERT INTO {rel} ({id1}, {id2})\n (SELECT %s, unnest(%s)) EXCEPT (SELECT {id1}, {id2} FROM {rel} WHERE {id1}=%s)\n \"\"\".format(rel=rel, id1=id1, id2=id2)\n for sub_ids in cr.split_for_in_conditions(ids):\n cr.execute(query, (id, list(sub_ids), id))\n\n def unlink_all():\n # remove all records for which user has access rights\n clauses, params, tables = obj.pool.get('ir.rule').domain_get(cr, user, obj._name, context=context)\n cond = \" AND \".join(clauses) if clauses else \"1=1\"\n query = \"\"\" DELETE FROM {rel} USING {tables}\n WHERE {rel}.{id1}=%s AND {rel}.{id2}={table}.id AND {cond}\n \"\"\".format(rel=rel, id1=id1, id2=id2,\n table=obj._table, tables=','.join(tables), cond=cond)\n cr.execute(query, [id] + params)\n\n for act in values:\n if not (isinstance(act, list) or isinstance(act, tuple)) or not act:\n continue\n if act[0] == 0:\n idnew = obj.create(cr, user, act[2], context=context)\n cr.execute('insert into '+rel+' ('+id1+','+id2+') values (%s,%s)', (id, idnew))\n elif act[0] == 1:\n obj.write(cr, user, [act[1]], act[2], context=context)\n elif act[0] == 2:\n obj.unlink(cr, user, [act[1]], context=context)\n elif act[0] == 3:\n cr.execute('delete from '+rel+' where ' + id1 + '=%s and '+ id2 + '=%s', (id, act[1]))\n elif act[0] == 4:\n link([act[1]])\n elif act[0] == 5:\n unlink_all()\n elif act[0] == 6:\n unlink_all()\n link(act[2])\n\n #\n # TODO: use a name_search\n #\n def search(self, cr, obj, args, name, value, offset=0, limit=None, uid=None, operator='like', context=None):\n return obj.pool[self._obj].search(cr, uid, args+self._domain+[('name', operator, value)], offset, limit, context=context)\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n raise NotImplementedError('Many2Many columns should not be used as record name (_rec_name)') \n\n\ndef get_nice_size(value):\n size = 0\n if isinstance(value, (int,long)):\n size = value\n elif value: # this is supposed to be a string\n size = len(value)\n if size < 12: # suppose human size\n return value\n return tools.human_size(size)\n\n# See http://www.w3.org/TR/2000/REC-xml-20001006#NT-Char\n# and http://bugs.python.org/issue10066\ninvalid_xml_low_bytes = re.compile(r'[\\x00-\\x08\\x0b-\\x0c\\x0e-\\x1f]')\n\ndef sanitize_binary_value(value):\n # binary fields should be 7-bit ASCII base64-encoded data,\n # but we do additional sanity checks to make sure the values\n # are not something else that won't pass via XML-RPC\n if isinstance(value, (xmlrpclib.Binary, tuple, list, dict)):\n # these builtin types are meant to pass untouched\n return value\n\n # Handle invalid bytes values that will cause problems\n # for XML-RPC. See for more info:\n # - http://bugs.python.org/issue10066\n # - http://www.w3.org/TR/2000/REC-xml-20001006#NT-Char\n\n # Coercing to unicode would normally allow it to properly pass via\n # XML-RPC, transparently encoded as UTF-8 by xmlrpclib.\n # (this works for _any_ byte values, thanks to the fallback\n # to latin-1 passthrough encoding when decoding to unicode)\n value = tools.ustr(value)\n\n # Due to Python bug #10066 this could still yield invalid XML\n # bytes, specifically in the low byte range, that will crash\n # the decoding side: [\\x00-\\x08\\x0b-\\x0c\\x0e-\\x1f]\n # So check for low bytes values, and if any, perform\n # base64 encoding - not very smart or useful, but this is\n # our last resort to avoid crashing the request.\n if invalid_xml_low_bytes.search(value):\n # b64-encode after restoring the pure bytes with latin-1\n # passthrough encoding\n value = base64.b64encode(value.encode('latin-1'))\n\n return value\n\n\n# ---------------------------------------------------------\n# Function fields\n# ---------------------------------------------------------\nclass function(_column):\n \"\"\"\n A field whose value is computed by a function (rather\n than being read from the database).\n\n :param fnct: the callable that will compute the field value.\n :param arg: arbitrary value to be passed to ``fnct`` when computing the value.\n :param fnct_inv: the callable that will allow writing values in that field\n (if not provided, the field is read-only).\n :param fnct_inv_arg: arbitrary value to be passed to ``fnct_inv`` when\n writing a value.\n :param str type: type of the field simulated by the function field\n :param fnct_search: the callable that allows searching on the field\n (if not provided, search will not return any result).\n :param store: store computed value in database\n (see :ref:`The *store* parameter <field-function-store>`).\n :type store: True or dict specifying triggers for field computation\n :param multi: name of batch for batch computation of function fields.\n All fields with the same batch name will be computed by\n a single function call. This changes the signature of the\n ``fnct`` callable.\n\n .. _field-function-fnct: The ``fnct`` parameter\n\n .. rubric:: The ``fnct`` parameter\n\n The callable implementing the function field must have the following signature:\n\n .. function:: fnct(model, cr, uid, ids, field_name(s), arg, context)\n\n Implements the function field.\n\n :param orm model: model to which the field belongs (should be ``self`` for\n a model method)\n :param field_name(s): name of the field to compute, or if ``multi`` is provided,\n list of field names to compute.\n :type field_name(s): str | [str]\n :param arg: arbitrary value passed when declaring the function field\n :rtype: dict\n :return: mapping of ``ids`` to computed values, or if multi is provided,\n to a map of field_names to computed values\n\n The values in the returned dictionary must be of the type specified by the type\n argument in the field declaration.\n\n Here is an example with a simple function ``char`` function field::\n\n # declarations\n def compute(self, cr, uid, ids, field_name, arg, context):\n result = {}\n # ...\n return result\n _columns['my_char'] = fields.function(compute, type='char', size=50)\n\n # when called with ``ids=[1,2,3]``, ``compute`` could return:\n {\n 1: 'foo',\n 2: 'bar',\n 3: False # null values should be returned explicitly too\n }\n\n If ``multi`` is set, then ``field_name`` is replaced by ``field_names``: a list\n of the field names that should be computed. Each value in the returned\n dictionary must then be a dictionary mapping field names to values.\n\n Here is an example where two function fields (``name`` and ``age``)\n are both computed by a single function field::\n\n # declarations\n def compute(self, cr, uid, ids, field_names, arg, context):\n result = {}\n # ...\n return result\n _columns['name'] = fields.function(compute_person_data, type='char',\\\n size=50, multi='person_data')\n _columns[''age'] = fields.function(compute_person_data, type='integer',\\\n multi='person_data')\n\n # when called with ``ids=[1,2,3]``, ``compute_person_data`` could return:\n {\n 1: {'name': 'Bob', 'age': 23},\n 2: {'name': 'Sally', 'age': 19},\n 3: {'name': 'unknown', 'age': False}\n }\n\n .. _field-function-fnct-inv:\n\n .. rubric:: The ``fnct_inv`` parameter\n\n This callable implements the write operation for the function field\n and must have the following signature:\n\n .. function:: fnct_inv(model, cr, uid, id, field_name, field_value, fnct_inv_arg, context)\n\n Callable that implements the ``write`` operation for the function field.\n\n :param orm model: model to which the field belongs (should be ``self`` for\n a model method)\n :param int id: the identifier of the object to write on\n :param str field_name: name of the field to set\n :param fnct_inv_arg: arbitrary value passed when declaring the function field\n :return: True\n\n When writing values for a function field, the ``multi`` parameter is ignored.\n\n .. _field-function-fnct-search:\n\n .. rubric:: The ``fnct_search`` parameter\n\n This callable implements the search operation for the function field\n and must have the following signature:\n\n .. function:: fnct_search(model, cr, uid, model_again, field_name, criterion, context)\n\n Callable that implements the ``search`` operation for the function field by expanding\n a search criterion based on the function field into a new domain based only on\n columns that are stored in the database.\n\n :param orm model: model to which the field belongs (should be ``self`` for\n a model method)\n :param orm model_again: same value as ``model`` (seriously! this is for backwards\n compatibility)\n :param str field_name: name of the field to search on\n :param list criterion: domain component specifying the search criterion on the field.\n :rtype: list\n :return: domain to use instead of ``criterion`` when performing the search.\n This new domain must be based only on columns stored in the database, as it\n will be used directly without any translation.\n\n The returned value must be a domain, that is, a list of the form [(field_name, operator, operand)].\n The most generic way to implement ``fnct_search`` is to directly search for the records that\n match the given ``criterion``, and return their ``ids`` wrapped in a domain, such as\n ``[('id','in',[1,3,5])]``.\n\n .. _field-function-store:\n\n .. rubric:: The ``store`` parameter\n\n The ``store`` parameter allows caching the result of the field computation in the\n database, and defining the triggers that will invalidate that cache and force a\n recomputation of the function field.\n When not provided, the field is computed every time its value is read.\n The value of ``store`` may be either ``True`` (to recompute the field value whenever\n any field in the same record is modified), or a dictionary specifying a more\n flexible set of recomputation triggers.\n\n A trigger specification is a dictionary that maps the names of the models that\n will trigger the computation, to a tuple describing the trigger rule, in the\n following form::\n\n store = {\n 'trigger_model': (mapping_function,\n ['trigger_field1', 'trigger_field2'],\n priority),\n }\n\n A trigger rule is defined by a 3-item tuple where:\n\n * The ``mapping_function`` is defined as follows:\n\n .. function:: mapping_function(trigger_model, cr, uid, trigger_ids, context)\n\n Callable that maps record ids of a trigger model to ids of the\n corresponding records in the source model (whose field values\n need to be recomputed).\n\n :param orm model: trigger_model\n :param list trigger_ids: ids of the records of trigger_model that were\n modified\n :rtype: list\n :return: list of ids of the source model whose function field values\n need to be recomputed\n\n * The second item is a list of the fields who should act as triggers for\n the computation. If an empty list is given, all fields will act as triggers.\n * The last item is the priority, used to order the triggers when processing them\n after any write operation on a model that has function field triggers. The\n default priority is 10.\n\n In fact, setting store = True is the same as using the following trigger dict::\n\n store = {\n 'model_itself': (lambda self, cr, uid, ids, context: ids,\n [],\n 10)\n }\n\n \"\"\"\n _properties = True\n\n __slots__ = [\n '_type',\n '_classic_read',\n '_classic_write',\n '_symbol_c',\n '_symbol_f',\n '_symbol_set',\n '_symbol_get',\n\n '_fnct',\n '_arg',\n '_fnct_inv',\n '_fnct_inv_arg',\n '_fnct_search',\n '_multi',\n 'store',\n\n '_digits',\n '_digits_compute',\n 'selection',\n '_obj',\n ]\n\n @property\n def digits(self):\n if self._digits_compute:\n with _get_cursor() as cr:\n return self._digits_compute(cr)\n else:\n return self._digits\n\n#\n# multi: compute several fields in one call\n#\n def __init__(self, fnct, arg=None, fnct_inv=None, fnct_inv_arg=None, type='float', fnct_search=None, obj=None, store=False, multi=False, **args):\n self._classic_read = False\n self._classic_write = False\n self._prefetch = False\n self._symbol_c = '%s'\n self._symbol_f = _symbol_set\n self._symbol_set = (self._symbol_c, self._symbol_f)\n self._symbol_get = None\n\n # pop attributes that should not be assigned to self\n self._digits = args.pop('digits', (16,2))\n self._digits_compute = args.pop('digits_compute', None)\n self._obj = args.pop('relation', obj)\n\n # function fields are not copied by default\n args['copy'] = args.get('copy', False)\n\n _column.__init__(self, **args)\n\n self._type = type\n self._fnct = fnct\n self._arg = arg\n self._fnct_inv = fnct_inv\n self._fnct_inv_arg = fnct_inv_arg\n self._fnct_search = fnct_search\n self.store = store\n self._multi = multi\n\n if not fnct_inv:\n self.readonly = 1\n\n if not fnct_search and not store:\n self.selectable = False\n\n if callable(args.get('selection')):\n from openerp import api\n self.selection = api.expected(api.cr_uid_context, args['selection'])\n\n if store:\n if self._type != 'many2one':\n # m2o fields need to return tuples with name_get, not just foreign keys\n self._classic_read = True\n self._classic_write = True\n if type=='binary':\n self._symbol_get=lambda x:x and str(x)\n else:\n self._prefetch = True\n\n if type == 'char':\n self._symbol_c = char._symbol_c\n self._symbol_f = lambda x: _symbol_set_char(self, x)\n self._symbol_set = (self._symbol_c, self._symbol_f)\n elif type == 'float':\n self._symbol_c = float._symbol_c\n self._symbol_f = lambda x: _symbol_set_float(self, x)\n self._symbol_set = (self._symbol_c, self._symbol_f)\n else:\n type_class = globals().get(type)\n if type_class is not None:\n self._symbol_c = type_class._symbol_c\n self._symbol_f = type_class._symbol_f\n self._symbol_set = type_class._symbol_set\n\n def new(self, _computed_field=False, **args):\n if _computed_field:\n # field is computed, we need an instance of a non-function column\n type_class = globals()[self._type]\n return type_class(**args)\n else:\n # HACK: function fields are tricky to recreate, simply return a copy\n import copy\n return copy.copy(self)\n\n def to_field_args(self):\n args = super(function, self).to_field_args()\n args['store'] = bool(self.store)\n args['company_dependent'] = False\n if self._type in ('float',):\n args['digits'] = self._digits_compute or self._digits\n elif self._type in ('selection', 'reference'):\n args['selection'] = self.selection\n elif self._type in ('many2one', 'one2many', 'many2many'):\n args['comodel_name'] = self._obj\n return args\n\n def digits_change(self, cr):\n pass\n\n def search(self, cr, uid, obj, name, args, context=None):\n if not self._fnct_search:\n #CHECKME: should raise an exception\n return []\n return self._fnct_search(obj, cr, uid, obj, name, args, context=context)\n\n def postprocess(self, cr, uid, obj, field, value=None, context=None):\n return self._postprocess_batch(cr, uid, obj, field, {0: value}, context=context)[0]\n\n def _postprocess_batch(self, cr, uid, obj, field, values, context=None):\n if not values:\n return values\n\n if context is None:\n context = {}\n\n field_type = obj._columns[field]._type\n new_values = dict(values)\n\n if field_type == 'binary':\n if context.get('bin_size'):\n # client requests only the size of binary fields\n for rid, value in values.iteritems():\n if value:\n new_values[rid] = get_nice_size(value)\n elif not context.get('bin_raw'):\n for rid, value in values.iteritems():\n if value:\n new_values[rid] = sanitize_binary_value(value)\n\n return new_values\n\n def get(self, cr, obj, ids, name, uid=False, context=None, values=None):\n multi = self._multi\n # if we already have a value, don't recompute it.\n # This happen if case of stored many2one fields\n if values and not multi and name in values[0]:\n result = dict((v['id'], v[name]) for v in values)\n elif values and multi and all(n in values[0] for n in name):\n result = dict((v['id'], dict((n, v[n]) for n in name)) for v in values)\n else:\n result = self._fnct(obj, cr, uid, ids, name, self._arg, context)\n if multi:\n swap = {}\n for rid, values in result.iteritems():\n for f, v in values.iteritems():\n if f not in name:\n continue\n swap.setdefault(f, {})[rid] = v\n\n for field, values in swap.iteritems():\n new_values = self._postprocess_batch(cr, uid, obj, field, values, context)\n for rid, value in new_values.iteritems():\n result[rid][field] = value\n\n else:\n result = self._postprocess_batch(cr, uid, obj, name, result, context)\n\n return result\n\n def set(self, cr, obj, id, name, value, user=None, context=None):\n if not context:\n context = {}\n if self._fnct_inv:\n self._fnct_inv(obj, cr, user, id, name, value, self._fnct_inv_arg, context)\n\n @classmethod\n def _as_display_name(cls, field, cr, uid, obj, value, context=None):\n # Function fields are supposed to emulate a basic field type,\n # so they can delegate to the basic type for record name rendering\n return globals()[field._type]._as_display_name(field, cr, uid, obj, value, context=context)\n\n# ---------------------------------------------------------\n# Related fields\n# ---------------------------------------------------------\n\nclass related(function):\n \"\"\"Field that points to some data inside another field of the current record.\n\n Example::\n\n _columns = {\n 'foo_id': fields.many2one('my.foo', 'Foo'),\n 'bar': fields.related('foo_id', 'frol', type='char', string='Frol of Foo'),\n }\n \"\"\"\n __slots__ = ['arg', '_relations']\n\n def _related_search(self, tobj, cr, uid, obj=None, name=None, domain=None, context=None):\n # assume self._arg = ('foo', 'bar', 'baz')\n # domain = [(name, op, val)] => search [('foo.bar.baz', op, val)]\n field = '.'.join(self._arg)\n return map(lambda x: (field, x[1], x[2]), domain)\n\n def _related_write(self, obj, cr, uid, ids, field_name, values, args, context=None):\n if isinstance(ids, (int, long)):\n ids = [ids]\n for instance in obj.browse(cr, uid, ids, context=context):\n # traverse all fields except the last one\n for field in self.arg[:-1]:\n instance = instance[field][:1]\n if instance:\n # write on the last field of the target record\n instance.write({self.arg[-1]: values})\n\n def _related_read(self, obj, cr, uid, ids, field_name, args, context=None):\n res = {}\n for record in obj.browse(cr, SUPERUSER_ID, ids, context=context):\n value = record\n # traverse all fields except the last one\n for field in self.arg[:-1]:\n value = value[field][:1]\n # read the last field on the target record\n res[record.id] = value[self.arg[-1]]\n\n if self._type == 'many2one':\n # res[id] is a recordset; convert it to (id, name) or False.\n # Perform name_get as root, as seeing the name of a related object depends on\n # access right of source document, not target, so user may not have access.\n value_ids = list(set(value.id for value in res.itervalues() if value))\n value_name = dict(obj.pool[self._obj].name_get(cr, SUPERUSER_ID, value_ids, context=context))\n res = dict((id, bool(value) and (value.id, value_name[value.id])) for id, value in res.iteritems())\n\n elif self._type in ('one2many', 'many2many'):\n # res[id] is a recordset; convert it to a list of ids\n res = dict((id, value.ids) for id, value in res.iteritems())\n\n return res\n\n def __init__(self, *arg, **args):\n self.arg = arg\n self._relations = []\n super(related, self).__init__(self._related_read, arg, self._related_write, fnct_inv_arg=arg, fnct_search=self._related_search, **args)\n if self.store is True:\n # TODO: improve here to change self.store = {...} according to related objects\n pass\n\n\nclass sparse(function):\n __slots__ = ['serialization_field']\n\n def convert_value(self, obj, cr, uid, record, value, read_value, context=None): \n \"\"\"\n + For a many2many field, a list of tuples is expected.\n Here is the list of tuple that are accepted, with the corresponding semantics ::\n\n (0, 0, { values }) link to a new record that needs to be created with the given values dictionary\n (1, ID, { values }) update the linked record with id = ID (write *values* on it)\n (2, ID) remove and delete the linked record with id = ID (calls unlink on ID, that will delete the object completely, and the link to it as well)\n (3, ID) cut the link to the linked record with id = ID (delete the relationship between the two objects but does not delete the target object itself)\n (4, ID) link to existing record with id = ID (adds a relationship)\n (5) unlink all (like using (3,ID) for all linked records)\n (6, 0, [IDs]) replace the list of linked IDs (like using (5) then (4,ID) for each ID in the list of IDs)\n\n Example:\n [(6, 0, [8, 5, 6, 4])] sets the many2many to ids [8, 5, 6, 4]\n\n + For a one2many field, a lits of tuples is expected.\n Here is the list of tuple that are accepted, with the corresponding semantics ::\n\n (0, 0, { values }) link to a new record that needs to be created with the given values dictionary\n (1, ID, { values }) update the linked record with id = ID (write *values* on it)\n (2, ID) remove and delete the linked record with id = ID (calls unlink on ID, that will delete the object completely, and the link to it as well)\n\n Example:\n [(0, 0, {'field_name':field_value_record1, ...}), (0, 0, {'field_name':field_value_record2, ...})]\n \"\"\"\n\n if self._type == 'many2many':\n if not value:\n return []\n assert value[0][0] == 6, 'Unsupported m2m value for sparse field: %s' % value\n return value[0][2]\n\n elif self._type == 'one2many':\n if not read_value:\n read_value = []\n relation_obj = obj.pool[self.relation]\n for vals in value:\n assert vals[0] in (0,1,2), 'Unsupported o2m value for sparse field: %s' % vals\n if vals[0] == 0:\n read_value.append(relation_obj.create(cr, uid, vals[2], context=context))\n elif vals[0] == 1:\n relation_obj.write(cr, uid, vals[1], vals[2], context=context)\n elif vals[0] == 2:\n relation_obj.unlink(cr, uid, vals[1], context=context)\n read_value.remove(vals[1])\n return read_value\n return value\n\n def _sparse_write(self,obj,cr, uid, ids, field_name, value, args, context=None):\n if not type(ids) == list:\n ids = [ids]\n records = obj.browse(cr, uid, ids, context=context)\n for record in records:\n # grab serialized value as object - already deserialized\n serialized = getattr(record, self.serialization_field)\n if value is None:\n # simply delete the key to unset it.\n serialized.pop(field_name, None)\n else: \n serialized[field_name] = self.convert_value(obj, cr, uid, record, value, serialized.get(field_name), context=context)\n obj.write(cr, uid, ids, {self.serialization_field: serialized}, context=context)\n return True\n\n def _sparse_read(self, obj, cr, uid, ids, field_names, args, context=None):\n results = {}\n records = obj.browse(cr, uid, ids, context=context)\n for record in records:\n # grab serialized value as object - already deserialized\n serialized = getattr(record, self.serialization_field)\n results[record.id] = {}\n for field_name in field_names:\n field_type = obj._columns[field_name]._type\n value = serialized.get(field_name, False)\n if field_type in ('one2many','many2many'):\n value = value or []\n if value:\n # filter out deleted records as superuser\n relation_obj = obj.pool[obj._columns[field_name].relation]\n value = relation_obj.exists(cr, openerp.SUPERUSER_ID, value)\n if type(value) in (int,long) and field_type == 'many2one':\n relation_obj = obj.pool[obj._columns[field_name].relation]\n # check for deleted record as superuser\n if not relation_obj.exists(cr, openerp.SUPERUSER_ID, [value]):\n value = False\n results[record.id][field_name] = value\n return results\n\n def __init__(self, serialization_field, **kwargs):\n self.serialization_field = serialization_field\n super(sparse, self).__init__(self._sparse_read, fnct_inv=self._sparse_write, multi='__sparse_multi', **kwargs)\n\n\n# ---------------------------------------------------------\n# Dummy fields\n# ---------------------------------------------------------\n\nclass dummy(function):\n __slots__ = ['arg', '_relations']\n\n def _dummy_search(self, tobj, cr, uid, obj=None, name=None, domain=None, context=None):\n return []\n\n def _dummy_write(self, obj, cr, uid, ids, field_name, values, args, context=None):\n return False\n\n def _dummy_read(self, obj, cr, uid, ids, field_name, args, context=None):\n return {}\n\n def __init__(self, *arg, **args):\n self.arg = arg\n self._relations = []\n super(dummy, self).__init__(self._dummy_read, arg, self._dummy_write, fnct_inv_arg=arg, fnct_search=self._dummy_search, **args)\n\n# ---------------------------------------------------------\n# Serialized fields\n# ---------------------------------------------------------\n\nclass serialized(_column):\n \"\"\" A field able to store an arbitrary python data structure.\n \n Note: only plain components allowed.\n \"\"\"\n _type = 'serialized'\n __slots__ = []\n\n def _symbol_set_struct(val):\n return simplejson.dumps(val)\n\n def _symbol_get_struct(self, val):\n return simplejson.loads(val or '{}')\n\n _symbol_c = '%s'\n _symbol_f = _symbol_set_struct\n _symbol_set = (_symbol_c, _symbol_f)\n _symbol_get = _symbol_get_struct\n\n def __init__(self, *args, **kwargs):\n kwargs['_prefetch'] = kwargs.get('_prefetch', False)\n super(serialized, self).__init__(*args, **kwargs)\n\n# TODO: review completly this class for speed improvement\nclass property(function):\n __slots__ = []\n\n def to_field_args(self):\n args = super(property, self).to_field_args()\n args['company_dependent'] = True\n return args\n\n def _property_search(self, tobj, cr, uid, obj, name, domain, context=None):\n ir_property = obj.pool['ir.property']\n result = []\n for field, operator, value in domain:\n result += ir_property.search_multi(cr, uid, name, tobj._name, operator, value, context=context)\n return result\n\n def _property_write(self, obj, cr, uid, id, prop_name, value, obj_dest, context=None):\n ir_property = obj.pool['ir.property']\n ir_property.set_multi(cr, uid, prop_name, obj._name, {id: value}, context=context)\n return True\n\n def _property_read(self, obj, cr, uid, ids, prop_names, obj_dest, context=None):\n ir_property = obj.pool['ir.property']\n\n res = {id: {} for id in ids}\n for prop_name in prop_names:\n field = obj._fields[prop_name]\n values = ir_property.get_multi(cr, uid, prop_name, obj._name, ids, context=context)\n if field.type == 'many2one':\n # name_get the non-null values as SUPERUSER_ID\n vals = sum(set(filter(None, values.itervalues())),\n obj.pool[field.comodel_name].browse(cr, uid, [], context=context))\n vals_name = dict(vals.sudo().name_get()) if vals else {}\n for id, value in values.iteritems():\n ng = False\n if value and value.id in vals_name:\n ng = value.id, vals_name[value.id]\n res[id][prop_name] = ng\n else:\n for id, value in values.iteritems():\n res[id][prop_name] = value\n\n return res\n\n def __init__(self, **args):\n if 'view_load' in args:\n _logger.warning(\"view_load attribute is deprecated on ir.fields. Args: %r\", args)\n args = dict(args)\n args['obj'] = args.pop('relation', '') or args.get('obj', '')\n super(property, self).__init__(\n fnct=self._property_read,\n fnct_inv=self._property_write,\n fnct_search=self._property_search,\n multi='properties',\n **args\n )\n\n\nclass column_info(object):\n \"\"\" Struct containing details about an osv column, either one local to\n its model, or one inherited via _inherits.\n\n .. attribute:: name\n\n name of the column\n\n .. attribute:: column\n\n column instance, subclass of :class:`_column`\n\n .. attribute:: parent_model\n\n if the column is inherited, name of the model that contains it,\n ``None`` for local columns.\n\n .. attribute:: parent_column\n\n the name of the column containing the m2o relationship to the\n parent model that contains this column, ``None`` for local columns.\n\n .. attribute:: original_parent\n\n if the column is inherited, name of the original parent model that\n contains it i.e in case of multilevel inheritance, ``None`` for\n local columns.\n \"\"\"\n __slots__ = ['name', 'column', 'parent_model', 'parent_column', 'original_parent']\n\n def __init__(self, name, column, parent_model=None, parent_column=None, original_parent=None):\n self.name = name\n self.column = column\n self.parent_model = parent_model\n self.parent_column = parent_column\n self.original_parent = original_parent\n\n def __str__(self):\n return '%s(%s, %s, %s, %s, %s)' % (\n self.__class__.__name__, self.name, self.column,\n self.parent_model, self.parent_column, self.original_parent)\n\n\n# vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}},{"rowIdx":227999,"cells":{"text":{"kind":"string","value":"# -*- coding: utf-8 -*-\n# Copyright 2015 Spotify AB. All rights reserved.\n#\n# The contents of this file are licensed under the Apache License, Version 2.0\n# (the \"License\"); you may not use this file except in compliance with the\n# License. You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations under\n# the License.\n\nfrom __future__ import unicode_literals\n\n# import stdlib\nimport re\nimport copy\nfrom collections import defaultdict\n\n# import third party lib\nfrom lxml import etree as ETREE\n\nfrom netaddr import IPAddress # needed for traceroute, to check IP version\nfrom netaddr.core import AddrFormatError\n\nfrom pyIOSXR import IOSXR\nfrom pyIOSXR.exceptions import ConnectError\nfrom pyIOSXR.exceptions import TimeoutError\nfrom pyIOSXR.exceptions import InvalidInputError\n\n# import NAPALM base\nimport napalm_base.helpers\nimport napalm_base.constants as C\nfrom napalm_base.base import NetworkDriver\nfrom napalm_base.utils import py23_compat\nfrom napalm_base.exceptions import ConnectionException\nfrom napalm_base.exceptions import MergeConfigException\nfrom napalm_base.exceptions import ReplaceConfigException\nfrom napalm_base.exceptions import CommandTimeoutException\nfrom napalm_base.utils.py23_compat import text_type\n\n\nclass IOSXRDriver(NetworkDriver):\n\n \"\"\"IOS-XR driver class: inherits NetworkDriver from napalm_base.\"\"\"\n\n def __init__(self, hostname, username, password, timeout=60, optional_args=None):\n self.hostname = hostname\n self.username = username\n self.password = password\n self.timeout = timeout\n self.pending_changes = False\n self.replace = False\n if optional_args is None:\n optional_args = {}\n self.port = optional_args.get('port', 22)\n self.lock_on_connect = optional_args.get('config_lock', True)\n self.device = IOSXR(hostname,\n username,\n password,\n timeout=timeout,\n port=self.port,\n lock=self.lock_on_connect)\n\n def open(self):\n try:\n self.device.open()\n except ConnectError as conn_err:\n raise ConnectionException(conn_err.args[0])\n\n def close(self):\n self.device.close()\n\n def is_alive(self):\n return {\n 'is_alive': self.device.device.remote_conn.transport.is_active()\n }\n\n def load_replace_candidate(self, filename=None, config=None):\n self.pending_changes = True\n self.replace = True\n if not self.lock_on_connect:\n self.device.lock()\n\n try:\n self.device.load_candidate_config(filename=filename, config=config)\n except InvalidInputError as e:\n self.pending_changes = False\n self.replace = False\n raise ReplaceConfigException(e.args[0])\n\n def load_merge_candidate(self, filename=None, config=None):\n self.pending_changes = True\n self.replace = False\n if not self.lock_on_connect:\n self.device.lock()\n\n try:\n self.device.load_candidate_config(filename=filename, config=config)\n except InvalidInputError as e:\n self.pending_changes = False\n self.replace = False\n raise MergeConfigException(e.args[0])\n\n def compare_config(self):\n if not self.pending_changes:\n return ''\n elif self.replace:\n return self.device.compare_replace_config().strip()\n else:\n return self.device.compare_config().strip()\n\n def commit_config(self):\n if self.replace:\n self.device.commit_replace_config()\n else:\n self.device.commit_config()\n self.pending_changes = False\n if not self.lock_on_connect:\n self.device.unlock()\n\n def discard_config(self):\n self.device.discard_config()\n self.pending_changes = False\n if not self.lock_on_connect:\n self.device.unlock()\n\n def rollback(self):\n self.device.rollback()\n\n def get_facts(self):\n\n facts = {\n 'vendor': u'Cisco',\n 'os_version': u'',\n 'hostname': u'',\n 'uptime': -1,\n 'serial_number': u'',\n 'fqdn': u'',\n 'model': u'',\n 'interface_list': []\n }\n\n facts_rpc_request = '<Get><Operational><SystemTime/><PlatformInventory/>\\\n </Operational></Get>'\n\n facts_rpc_reply = ETREE.fromstring(self.device.make_rpc_call(facts_rpc_request))\n system_time_xpath = './/SystemTime/Uptime'\n platform_attr_xpath = './/RackTable/Rack/Attributes/BasicInfo'\n system_time_tree = facts_rpc_reply.xpath(system_time_xpath)[0]\n platform_attr_tree = facts_rpc_reply.xpath(platform_attr_xpath)[0]\n\n hostname = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(system_time_tree, 'Hostname'))\n uptime = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(system_time_tree, 'Uptime'), -1)\n serial = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(platform_attr_tree, 'SerialNumber'))\n os_version = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(platform_attr_tree, 'SoftwareRevision'))\n model = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(platform_attr_tree, 'ModelName'))\n interface_list = sorted(list(self.get_interfaces().keys()))\n\n facts.update({\n 'os_version': os_version,\n 'hostname': hostname,\n 'model': model,\n 'uptime': uptime,\n 'serial_number': serial,\n 'fqdn': hostname,\n 'interface_list': interface_list\n })\n\n return facts\n\n def get_interfaces(self):\n\n interfaces = {}\n\n INTERFACE_DEFAULTS = {\n 'is_enabled': False,\n 'is_up': False,\n 'mac_address': u'',\n 'description': u'',\n 'speed': -1,\n 'last_flapped': -1.0\n }\n\n interfaces_rpc_request = '<Get><Operational><Interfaces/></Operational></Get>'\n\n interfaces_rpc_reply = ETREE.fromstring(\n self.device.make_rpc_call(interfaces_rpc_request))\n\n for interface_tree in interfaces_rpc_reply.xpath('.//Interfaces/InterfaceTable/Interface'):\n interface_name = napalm_base.helpers.find_txt(interface_tree, 'Naming/InterfaceName')\n if not interface_name:\n continue\n is_up = (napalm_base.helpers.find_txt(interface_tree, 'LineState') == 'IM_STATE_UP')\n enabled = (napalm_base.helpers.find_txt(interface_tree, 'State') == 'IM_STATE_UP')\n raw_mac = napalm_base.helpers.find_txt(interface_tree, 'MACAddress/Address')\n mac_address = napalm_base.helpers.convert(\n napalm_base.helpers.mac, raw_mac, raw_mac)\n speed = napalm_base.helpers.convert(\n int, napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface_tree, 'Bandwidth'), 0) * 1e-3)\n description = napalm_base.helpers.find_txt(interface_tree, 'Description')\n interfaces[interface_name] = copy.deepcopy(INTERFACE_DEFAULTS)\n interfaces[interface_name].update({\n 'is_up': is_up,\n 'speed': speed,\n 'is_enabled': enabled,\n 'mac_address': mac_address,\n 'description': description\n })\n\n return interfaces\n\n def get_interfaces_counters(self):\n rpc_command = '<Get><Operational><Interfaces><InterfaceTable></InterfaceTable>\\\n </Interfaces></Operational></Get>'\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n interface_counters = {}\n\n for interface in result_tree.xpath('.//Interface'):\n interface_name = napalm_base.helpers.find_txt(interface, 'InterfaceHandle')\n interface_stats = {}\n if not interface.xpath('InterfaceStatistics'):\n continue\n else:\n interface_stats = {}\n interface_stats['tx_multicast_packets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/MulticastPacketsSent'))\n interface_stats['tx_discards'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/OutputDrops'))\n interface_stats['tx_octets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/BytesSent'))\n interface_stats['tx_errors'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/OutputErrors'))\n interface_stats['rx_octets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/BytesReceived'))\n interface_stats['tx_unicast_packets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/PacketsSent'))\n interface_stats['rx_errors'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/InputErrors'))\n interface_stats['tx_broadcast_packets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/BroadcastPacketsSent'))\n interface_stats['rx_multicast_packets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/MulticastPacketsReceived'))\n interface_stats['rx_broadcast_packets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/BroadcastPacketsReceived'))\n interface_stats['rx_discards'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/InputDrops'))\n interface_stats['rx_unicast_packets'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface,\n 'InterfaceStatistics/FullInterfaceStats/PacketsReceived'))\n interface_counters[interface_name] = interface_stats\n\n return interface_counters\n\n def get_bgp_neighbors(self):\n def generate_vrf_query(vrf_name):\n \"\"\"\n Helper to provide XML-query for the VRF-type we're interested in.\n \"\"\"\n if vrf_name == \"global\":\n rpc_command = '<Get><Operational><BGP><InstanceTable><Instance><Naming>\\\n <InstanceName>default</InstanceName></Naming><InstanceActive><DefaultVRF>\\\n <GlobalProcessInfo></GlobalProcessInfo><NeighborTable></NeighborTable></DefaultVRF>\\\n </InstanceActive></Instance></InstanceTable></BGP></Operational></Get>'\n\n else:\n rpc_command = '<Get><Operational><BGP><InstanceTable><Instance><Naming>\\\n <InstanceName>default</InstanceName></Naming><InstanceActive><VRFTable><VRF>\\\n <Naming>{vrf_name}</Naming><GlobalProcessInfo></GlobalProcessInfo><NeighborTable>\\\n </NeighborTable></VRF></VRFTable></InstanceActive></Instance></InstanceTable>\\\n </BGP></Operational></Get>'.format(vrf_name=vrf_name)\n return rpc_command\n\n \"\"\"\n Initial run to figure out what VRF's are available\n Decided to get this one from Configured-section\n because bulk-getting all instance-data to do the same could get ridiculously heavy\n Assuming we're always interested in the DefaultVRF\n \"\"\"\n\n active_vrfs = [\"global\"]\n\n rpc_command = '<Get><Operational><BGP><ConfigInstanceTable><ConfigInstance><Naming>\\\n <InstanceName>default</InstanceName></Naming><ConfigInstanceVRFTable>\\\n </ConfigInstanceVRFTable></ConfigInstance></ConfigInstanceTable></BGP></Operational></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for node in result_tree.xpath('.//ConfigVRF'):\n active_vrfs.append(napalm_base.helpers.find_txt(node, 'Naming/VRFName'))\n\n result = {}\n\n for vrf in active_vrfs:\n rpc_command = generate_vrf_query(vrf)\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n this_vrf = {}\n this_vrf['peers'] = {}\n\n if vrf == \"global\":\n this_vrf['router_id'] = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(result_tree,\n 'Get/Operational/BGP/InstanceTable/Instance/InstanceActive/DefaultVRF\\\n /GlobalProcessInfo/VRF/RouterID'))\n else:\n this_vrf['router_id'] = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(result_tree,\n 'Get/Operational/BGP/InstanceTable/Instance/InstanceActive/VRFTable/VRF\\\n /GlobalProcessInfo/VRF/RouterID'))\n\n neighbors = {}\n\n for neighbor in result_tree.xpath('.//Neighbor'):\n this_neighbor = {}\n this_neighbor['local_as'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'LocalAS'))\n this_neighbor['remote_as'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'RemoteAS'))\n this_neighbor['remote_id'] = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'RouterID'))\n\n if napalm_base.helpers.find_txt(neighbor, 'ConnectionAdminStatus') is \"1\":\n this_neighbor['is_enabled'] = True\n try:\n this_neighbor['description'] = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'Description'))\n except AttributeError:\n this_neighbor['description'] = u''\n\n this_neighbor['is_enabled'] = (\n napalm_base.helpers.find_txt(neighbor, 'ConnectionAdminStatus') == \"1\")\n\n if str(napalm_base.helpers.find_txt(neighbor, 'ConnectionAdminStatus')) is \"1\":\n this_neighbor['is_enabled'] = True\n else:\n this_neighbor['is_enabled'] = False\n\n if str(napalm_base.helpers.find_txt(neighbor, 'ConnectionState')) == \"BGP_ST_ESTAB\":\n this_neighbor['is_up'] = True\n this_neighbor['uptime'] = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'ConnectionEstablishedTime'))\n else:\n this_neighbor['is_up'] = False\n this_neighbor['uptime'] = -1\n\n this_neighbor['address_family'] = {}\n\n if napalm_base.helpers.find_txt(neighbor,\n 'ConnectionRemoteAddress/AFI') == \"IPv4\":\n this_afi = \"ipv4\"\n elif napalm_base.helpers.find_txt(neighbor,\n 'ConnectionRemoteAddress/AFI') == \"IPv6\":\n this_afi = \"ipv6\"\n else:\n this_afi = napalm_base.helpers.find_txt(neighbor, 'ConnectionRemoteAddress/AFI')\n\n this_neighbor['address_family'][this_afi] = {}\n\n try:\n this_neighbor['address_family'][this_afi][\"received_prefixes\"] = \\\n napalm_base.helpers.convert(int,\n napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/PrefixesAccepted'), 0) + \\\n napalm_base.helpers.convert(int,\n napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/PrefixesDenied'), 0)\n this_neighbor['address_family'][this_afi][\"accepted_prefixes\"] = \\\n napalm_base.helpers.convert(int,\n napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/PrefixesAccepted'), 0)\n this_neighbor['address_family'][this_afi][\"sent_prefixes\"] = \\\n napalm_base.helpers.convert(int,\n napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/PrefixesAdvertised'), 0)\n except AttributeError:\n this_neighbor['address_family'][this_afi][\"received_prefixes\"] = -1\n this_neighbor['address_family'][this_afi][\"accepted_prefixes\"] = -1\n this_neighbor['address_family'][this_afi][\"sent_prefixes\"] = -1\n\n neighbor_ip = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(\n neighbor, 'Naming/NeighborAddress/IPV4Address') or\n napalm_base.helpers.find_txt(\n neighbor, 'Naming/NeighborAddress/IPV6Address')\n )\n\n neighbors[neighbor_ip] = this_neighbor\n\n this_vrf['peers'] = neighbors\n result[vrf] = this_vrf\n\n return result\n\n def get_environment(self):\n def get_module_xml_query(module, selection):\n return '<Get><AdminOperational><EnvironmentalMonitoring><RackTable><Rack><Naming>\\\n <rack>0</rack></Naming><SlotTable><Slot><Naming><slot>{slot}</slot></Naming>{name}\\\n </Slot></SlotTable></Rack></RackTable></EnvironmentalMonitoring></AdminOperational>\\\n </Get>'.format(slot=module, name=selection)\n\n environment_status = {}\n environment_status['fans'] = {}\n environment_status['temperature'] = {}\n environment_status['power'] = {}\n environment_status['cpu'] = {}\n environment_status['memory'] = 0.0\n\n # finding slots with equipment we're interested in\n rpc_command = '<Get><AdminOperational><PlatformInventory><RackTable><Rack><Naming>\\\n <Name>0</Name></Naming><SlotTable></SlotTable></Rack></RackTable></PlatformInventory>\\\n </AdminOperational></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n active_modules = defaultdict(list)\n\n for slot in result_tree.xpath(\".//Slot\"):\n for card in slot.xpath(\".//CardTable\"):\n # find enabled slots, figoure out type and save for later\n if napalm_base.helpers.find_txt(card,\n 'Card/Attributes/FRUInfo/ModuleAdministrativeState') == \"ADMIN_UP\":\n slot_name = napalm_base.helpers.find_txt(slot, 'Naming/Name')\n module_type = re.sub(\"\\d+\", \"\", slot_name)\n if len(module_type) > 0:\n active_modules[module_type].append(slot_name)\n else:\n active_modules[\"LC\"].append(slot_name)\n\n #\n # PSU's\n #\n\n for psu in active_modules['PM']:\n if psu in [\"PM6\", \"PM7\"]: # Cisco bug, chassis difference V01<->V02\n continue\n\n rpc_command = get_module_xml_query(psu, '')\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n psu_status = {}\n psu_status['status'] = False\n psu_status['capacity'] = 0.0\n psu_status['output'] = 0.0\n\n for sensor in result_tree.xpath('.//SensorName'):\n if napalm_base.helpers.find_txt(sensor, 'Naming/Name') == \"host__VOLT\":\n this_psu_voltage = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(sensor, 'ValueBrief'))\n elif napalm_base.helpers.find_txt(sensor, 'Naming/Name') == \"host__CURR\":\n this_psu_current = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(sensor, 'ValueBrief'))\n elif napalm_base.helpers.find_txt(sensor, 'Naming/Name') == \"host__PM\":\n this_psu_capacity = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(sensor, 'ValueBrief'))\n\n if this_psu_capacity > 0:\n psu_status['capacity'] = this_psu_capacity\n psu_status['status'] = True\n\n if this_psu_current and this_psu_voltage:\n psu_status['output'] = (this_psu_voltage * this_psu_current) / 1000000.0\n\n environment_status['power'][psu] = psu_status\n\n #\n # Memory\n #\n\n facts = self.get_facts()\n router_model = facts.get('model')\n is_xrv = router_model.lower().startswith('xrv')\n environment_status['memory'] = {\n 'available_ram': 0.0,\n 'used_ram': 0.0\n }\n\n if not is_xrv:\n rpc_command = '<Get><AdminOperational><MemorySummary>\\\n </MemorySummary></AdminOperational></Get>'\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for node in result_tree.xpath('.//Node'):\n if napalm_base.helpers.find_txt(node,\n 'Naming/NodeName/Slot') == active_modules['RSP'][0]:\n available_ram = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(node, 'Summary/SystemRAMMemory'))\n free_ram = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(node, 'Summary/FreeApplicationMemory'))\n break # we're only looking at one of the RSP's\n\n if available_ram and free_ram:\n used_ram = available_ram - free_ram\n memory = {}\n memory['available_ram'] = available_ram\n memory['used_ram'] = used_ram\n environment_status['memory'] = memory\n\n #\n # Fans\n #\n\n for fan in active_modules['FT']:\n rpc_command = get_module_xml_query(fan, '')\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n for module in result_tree.xpath('.//Module'):\n for sensortype in module.xpath('.//SensorType'):\n for sensorname in sensortype.xpath('.//SensorNameTable'):\n if napalm_base.helpers.find_txt(sensorname,\n 'SensorName/Naming/Name') == \"host__FanSpeed_0\":\n environment_status['fans'][fan] = {\n 'status': napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(sensorname,\n 'SensorName/ValueDetailed/Status')\n ) == 1\n }\n\n #\n # CPU\n #\n cpu = {}\n\n rpc_command = '<Get><Operational><SystemMonitoring></SystemMonitoring></Operational></Get>'\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for module in result_tree.xpath('.//CPUUtilization'):\n this_cpu = {}\n this_cpu[\"%usage\"] = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(module, 'TotalCPUFiveMinute'))\n\n rack = napalm_base.helpers.find_txt(module, 'Naming/NodeName/Rack')\n slot = napalm_base.helpers.find_txt(module, 'Naming/NodeName/Slot')\n instance = napalm_base.helpers.find_txt(module, 'Naming/NodeName/Instance')\n position = \"%s/%s/%s\" % (rack, slot, instance)\n\n cpu[position] = this_cpu\n\n environment_status[\"cpu\"] = cpu\n\n #\n # Temperature\n #\n\n slot_list = set()\n for category, slot in active_modules.items():\n slot_list |= set(slot)\n\n if not is_xrv:\n for slot in slot_list:\n rpc_command = get_module_xml_query(slot, '')\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n for sensor in result_tree.xpath(\".//SensorName\"):\n if not napalm_base.helpers.find_txt(sensor, 'Naming/Name') == \"host__Inlet0\":\n continue\n this_reading = {}\n this_reading['temperature'] = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(sensor, 'ValueBrief'))\n threshold_value = [\n napalm_base.helpers.convert(float, x.text)\n for x in sensor.xpath(\"ThresholdTable/Threshold/ValueBrief\")\n ]\n this_reading['is_alert'] = \\\n threshold_value[2] <= this_reading['temperature'] <= threshold_value[3]\n this_reading['is_critical'] = \\\n threshold_value[4] <= this_reading['temperature'] <= threshold_value[5]\n this_reading['temperature'] = this_reading['temperature']/10\n environment_status[\"temperature\"][slot] = this_reading\n\n return environment_status\n\n def get_lldp_neighbors(self):\n\n # init result dict\n lldp = {}\n sh_lldp = self.device.show_lldp_neighbors().splitlines()[5:-3]\n\n for n in sh_lldp:\n local_interface = n.split()[1]\n if local_interface not in lldp.keys():\n lldp[local_interface] = []\n\n lldp[local_interface].append({\n 'hostname': napalm_base.helpers.convert(\n text_type, n.split()[0]),\n 'port': napalm_base.helpers.convert(\n text_type, n.split()[4])\n })\n\n return lldp\n\n def get_lldp_neighbors_detail(self, interface=''):\n\n lldp_neighbors = {}\n\n rpc_command = '<Get><Operational><LLDP></LLDP></Operational></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for neighbor in result_tree.xpath('.//Neighbors/DetailTable/Detail/Entry'):\n interface_name = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'ReceivingInterfaceName'))\n parent_interface = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'ReceivingParentInterfaceName'))\n chassis_id_raw = napalm_base.helpers.find_txt(neighbor, 'ChassisID')\n chassis_id = napalm_base.helpers.convert(\n napalm_base.helpers.mac, chassis_id_raw, chassis_id_raw)\n port_id = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'PortIDDetail'))\n port_descr = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'Detail/PortDescription'))\n system_name = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'Detail/SystemName'))\n system_descr = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'Detail/SystemDescription'))\n system_capabilities = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'Detail/SystemCapabilities'))\n enabled_capabilities = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(neighbor, 'Detail/EnabledCapabilities'))\n\n if interface_name not in lldp_neighbors.keys():\n lldp_neighbors[interface_name] = []\n lldp_neighbors[interface_name].append({\n 'parent_interface': parent_interface,\n 'remote_chassis_id': chassis_id,\n 'remote_port': port_id,\n 'remote_port_description': port_descr,\n 'remote_system_name': system_name,\n 'remote_system_description': system_descr,\n 'remote_system_capab': system_capabilities,\n 'remote_system_enable_capab': enabled_capabilities\n })\n\n return lldp_neighbors\n\n def cli(self, commands):\n\n cli_output = {}\n\n if type(commands) is not list:\n raise TypeError('Please enter a valid list of commands!')\n\n for command in commands:\n try:\n cli_output[text_type(command)] = text_type(self.device._execute_show(command))\n except TimeoutError:\n cli_output[text_type(command)] = 'Execution of command \\\n \"{command}\" took too long! Please adjust your params!'.format(command=command)\n raise CommandTimeoutException(str(cli_output))\n\n return cli_output\n\n def get_bgp_config(self, group='', neighbor=''):\n\n bgp_config = {}\n\n # a helper\n def build_prefix_limit(af_table, limit, prefix_percent, prefix_timeout):\n prefix_limit = {}\n inet = False\n inet6 = False\n preifx_type = 'inet'\n if 'IPV4' in af_table:\n inet = True\n if 'IPv6' in af_table:\n inet6 = True\n preifx_type = 'inet6'\n if inet or inet6:\n prefix_limit = {\n preifx_type: {\n af_table[4:].lower(): {\n 'limit': limit,\n 'teardown': {\n 'threshold': prefix_percent,\n 'timeout': prefix_timeout\n }\n }\n }\n }\n return prefix_limit\n\n # here begins actual method...\n\n rpc_command = '<Get><Configuration><BGP><Instance><Naming>\\\n <InstanceName>default</InstanceName></Naming></Instance></BGP></Configuration></Get>'\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n group = group.lower()\n neighbor = neighbor.lower()\n\n if not group:\n neighbor = ''\n\n bgp_group_neighbors = {}\n for bgp_neighbor in result_tree.xpath('.//Neighbor'):\n group_name = napalm_base.helpers.find_txt(bgp_neighbor, 'NeighborGroupAddMember')\n peer = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(bgp_neighbor, 'Naming/NeighborAddress/IPV4Address') or\n napalm_base.helpers.find_txt(bgp_neighbor, 'Naming/NeighborAddress/IPV6Address')\n )\n if neighbor and peer != neighbor:\n continue\n description = napalm_base.helpers.find_txt(bgp_neighbor, 'Description')\n peer_as = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_neighbor, 'RemoteAS/AS_YY'), 0)\n local_as = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_neighbor, 'LocalAS/AS_YY'), 0)\n af_table = napalm_base.helpers.find_txt(\n bgp_neighbor, 'NeighborAFTable/NeighborAF/Naming/AFName')\n prefix_limit = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_neighbor,\n 'NeighborAFTable/NeighborAF/MaximumPrefixes/PrefixLimit'), 0)\n prefix_percent = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_neighbor,\n 'NeighborAFTable/NeighborAF/MaximumPrefixes/WarningPercentage'), 0)\n prefix_timeout = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_neighbor,\n 'NeighborAFTable/NeighborAF/MaximumPrefixes/RestartTime'), 0)\n import_policy = napalm_base.helpers.find_txt(\n bgp_neighbor, 'NeighborAFTable/NeighborAF/RoutePolicyIn')\n export_policy = napalm_base.helpers.find_txt(\n bgp_neighbor, 'NeighborAFTable/NeighborAF/RoutePolicyOut')\n local_addr_raw = (napalm_base.helpers.find_txt(bgp_neighbor,\n 'LocalAddress/LocalIPAddress/IPV4Address') or\n napalm_base.helpers.find_txt(bgp_neighbor,\n 'LocalAddress/LocalIPAddress/IPV6Address'))\n local_address = napalm_base.helpers.convert(napalm_base.helpers.ip,\n local_addr_raw, local_addr_raw)\n password = napalm_base.helpers.find_txt(bgp_neighbor, 'Password/Password/Password')\n nhs = False\n route_reflector = False\n if group_name not in bgp_group_neighbors.keys():\n bgp_group_neighbors[group_name] = {}\n bgp_group_neighbors[group_name][peer] = {\n 'description': description,\n 'remote_as': peer_as,\n 'prefix_limit': build_prefix_limit(\n af_table, prefix_limit, prefix_percent, prefix_timeout),\n 'export_policy': export_policy,\n 'import_policy': import_policy,\n 'local_address': local_address,\n 'local_as': local_as,\n 'authentication_key': password,\n 'nhs': nhs,\n 'route_reflector_client': route_reflector\n }\n if neighbor and peer == neighbor:\n break\n\n for bgp_group in result_tree.xpath('.//NeighborGroup'):\n group_name = napalm_base.helpers.find_txt(bgp_group, 'Naming/NeighborGroupName')\n if group and group != group_name:\n continue\n bgp_type = 'external' # by default external\n # must check\n description = napalm_base.helpers.find_txt(bgp_group, 'Description')\n import_policy = napalm_base.helpers.find_txt(\n bgp_group, 'NeighborGroupAFTable/NeighborGroupAF/RoutePolicyIn')\n export_policy = napalm_base.helpers.find_txt(\n bgp_group, 'NeighborGroupAFTable/NeighborGroupAF/RoutePolicyOut')\n multipath = eval((napalm_base.helpers.find_txt(\n bgp_group, 'NeighborGroupAFTable/NeighborGroupAF/Multipath') or 'false').title())\n peer_as = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_group, 'RemoteAS/AS_YY'), 0)\n local_as = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_group, 'LocalAS/AS_YY'), 0)\n multihop_ttl = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_group, 'EBGPMultihop/MaxHopCount'), 0)\n local_addr_raw = (napalm_base.helpers.find_txt(\n bgp_group, 'LocalAddress/LocalIPAddress/IPV4Address') or\n napalm_base.helpers.find_txt(\n bgp_group, 'LocalAddress/LocalIPAddress/IPV6Address'))\n local_address = napalm_base.helpers.convert(\n napalm_base.helpers.ip, local_addr_raw, local_addr_raw)\n af_table = napalm_base.helpers.find_txt(\n bgp_group, 'NeighborAFTable/NeighborAF/Naming/AFName')\n prefix_limit = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n bgp_group,\n 'NeighborGroupAFTable/NeighborGroupAF/MaximumPrefixes/PrefixLimit'), 0)\n prefix_percent = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_group,\n 'NeighborGroupAFTable/NeighborGroupAF/MaximumPrefixes/WarningPercentage'), 0)\n prefix_timeout = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(bgp_group,\n 'NeighborGroupAFTable/NeighborGroupAF/MaximumPrefixes/RestartTime'), 0)\n remove_private = True # is it specified in the XML?\n bgp_config[group_name] = {\n 'apply_groups': [], # on IOS-XR will always be empty list!\n 'description': description,\n 'local_as': local_as,\n 'type': text_type(bgp_type),\n 'import_policy': import_policy,\n 'export_policy': export_policy,\n 'local_address': local_address,\n 'multipath': multipath,\n 'multihop_ttl': multihop_ttl,\n 'remote_as': peer_as,\n 'remove_private_as': remove_private,\n 'prefix_limit': build_prefix_limit(\n af_table, prefix_limit, prefix_percent, prefix_timeout),\n 'neighbors': bgp_group_neighbors.get(group_name, {})\n }\n if group and group == group_name:\n break\n\n return bgp_config\n\n def get_bgp_neighbors_detail(self, neighbor_address=''):\n\n bgp_neighbors_detail = {}\n\n active_vrfs = ['default']\n\n active_vrfs_rpc_request = '<Get><Operational><BGP><ConfigInstanceTable><ConfigInstance>\\\n <Naming><InstanceName>default</InstanceName></Naming><ConfigInstanceVRFTable/>\\\n </ConfigInstance></ConfigInstanceTable></BGP></Operational></Get>'\n\n active_vrfs_rpc_reply = ETREE.fromstring(\n self.device.make_rpc_call(active_vrfs_rpc_request))\n active_vrfs_tree = active_vrfs_rpc_reply.xpath('.//ConfigVRF')\n\n for active_vrf_tree in active_vrfs_tree:\n active_vrfs.append(napalm_base.helpers.find_txt(active_vrf_tree, 'Naming/VRFName'))\n\n unique_active_vrfs = sorted(set(active_vrfs))\n\n bgp_neighbors_vrf_all_rpc = '<Get><Operational><BGP><InstanceTable><Instance><Naming>\\\n <InstanceName>default</InstanceName></Naming>'\n\n for active_vrf in unique_active_vrfs:\n vrf_rpc = '<InstanceActive><VRFTable><VRF><Naming>{vrf_name}</Naming>\\\n <GlobalProcessInfo/><NeighborTable/></VRF></VRFTable></InstanceActive>'\n bgp_neighbors_vrf_all_rpc += vrf_rpc.format(vrf_name=active_vrf)\n\n bgp_neighbors_vrf_all_rpc += '</Instance></InstanceTable></BGP></Operational></Get>'\n\n bgp_neighbors_vrf_all_tree = ETREE.fromstring(\n self.device.make_rpc_call(bgp_neighbors_vrf_all_rpc))\n\n _BGP_STATE_ = {\n '0': 'Unknown',\n '1': 'Idle',\n '2': 'Connect',\n '3': 'OpenSent',\n '4': 'OpenConfirm',\n '5': 'Active',\n '6': 'Established'\n }\n\n instance_active_list = bgp_neighbors_vrf_all_tree.xpath(\n './/InstanceTable/Instance/InstanceActive/VRFTable/VRF')\n\n for vrf_tree in instance_active_list:\n vrf_name = napalm_base.helpers.find_txt(vrf_tree, 'Naming/VRFName')\n vrf_keepalive = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n instance_active_list, 'GlobalProcessInfo/VRF/KeepAliveTime'))\n vrf_holdtime = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n instance_active_list, 'GlobalProcessInfo/VRF/HoldTime'))\n if vrf_name not in bgp_neighbors_detail.keys():\n bgp_neighbors_detail[vrf_name] = {}\n for neighbor in vrf_tree.xpath('NeighborTable/Neighbor'):\n up = (napalm_base.helpers.find_txt(neighbor, 'ConnectionState') == 'BGP_ST_ESTAB')\n local_as = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'LocalAS'), 0)\n remote_as = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'RemoteAS'), 0)\n router_id = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(neighbor, 'RouterID'))\n remote_address = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(neighbor, 'Naming/NeighborAddress/IPV4Address') or\n napalm_base.helpers.find_txt(neighbor, 'Naming/NeighborAddress/IPV6Address')\n )\n local_address_configured = eval(napalm_base.helpers.find_txt(\n neighbor, 'IsLocalAddressConfigured', 'false').title())\n local_address = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(neighbor, 'ConnectionLocalAddress/IPV4Address') or\n napalm_base.helpers.find_txt(neighbor, 'ConnectionLocalAddress/IPV6Address')\n )\n local_port = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'ConnectionLocalPort'))\n remote_address = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(neighbor, 'ConnectionRemoteAddress/IPV4Address') or\n napalm_base.helpers.find_txt(neighbor, 'ConnectionRemoteAddress/IPV6Address')\n )\n remote_port = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'ConnectionRemotePort'))\n multihop = eval(napalm_base.helpers.find_txt(\n neighbor, 'IsExternalNeighborNotDirectlyConnected', 'false').title())\n remove_private_as = eval(napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/RemovePrivateASFromUpdates', 'false').title())\n multipath = eval(napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/SelectiveMultipathEligible', 'false').title())\n import_policy = napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/RoutePolicyIn')\n export_policy = napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/RoutePolicyOut')\n input_messages = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'MessgesReceived'), 0)\n output_messages = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'MessagesSent'), 0)\n connection_down_count = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'ConnectionDownCount'), 0)\n messages_queued_out = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'MessagesQueuedOut'), 0)\n connection_state = napalm_base.helpers.find_txt(\n neighbor, 'ConnectionState').replace('BGP_ST_', '').title()\n if connection_state == u'Estab':\n connection_state = u'Established'\n previous_connection_state = napalm_base.helpers.convert(\n text_type, _BGP_STATE_.get(napalm_base.helpers.find_txt(\n neighbor, 'PreviousConnectionState', '0')))\n active_prefix_count = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/NumberOfBestpaths'), 0)\n accepted_prefix_count = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/PrefixesAccepted'), 0)\n suppressed_prefix_count = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'AFData/Entry/PrefixesDenied'), 0)\n received_prefix_count = accepted_prefix_count + suppressed_prefix_count\n advertised_prefix_count = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n neighbor, 'AFData/Entry/PrefixesAdvertised'), 0)\n suppress_4byte_as = eval(napalm_base.helpers.find_txt(\n neighbor, 'Suppress4ByteAs', 'false').title())\n local_as_prepend = not eval(napalm_base.helpers.find_txt(\n neighbor, 'LocalASNoPrepend', 'false').title())\n holdtime = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'HoldTime'), 0) or vrf_holdtime\n configured_holdtime = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'ConfiguredHoldTime'), 0)\n keepalive = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'KeepAliveTime'), 0) \\\n or vrf_keepalive\n configured_keepalive = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(neighbor, 'ConfiguredKeepalive'), 0)\n flap_count = int(connection_down_count / 2)\n if up:\n flap_count -= 1\n if remote_as not in bgp_neighbors_detail[vrf_name].keys():\n bgp_neighbors_detail[vrf_name][remote_as] = []\n bgp_neighbors_detail[vrf_name][remote_as].append({\n 'up': up,\n 'local_as': local_as,\n 'remote_as': remote_as,\n 'router_id': router_id,\n 'local_address': local_address,\n 'routing_table': vrf_name,\n 'local_address_configured': local_address_configured,\n 'local_port': local_port,\n 'remote_address': remote_address,\n 'remote_port': remote_port,\n 'multihop': multihop,\n 'multipath': multipath,\n 'import_policy': import_policy,\n 'export_policy': export_policy,\n 'input_messages': input_messages,\n 'output_messages': output_messages,\n 'input_updates': 0,\n 'output_updates': 0,\n 'messages_queued_out': messages_queued_out,\n 'connection_state': connection_state,\n 'previous_connection_state': previous_connection_state,\n 'last_event': u'',\n 'remove_private_as': remove_private_as,\n 'suppress_4byte_as': suppress_4byte_as,\n 'local_as_prepend': local_as_prepend,\n 'holdtime': holdtime,\n 'configured_holdtime': configured_holdtime,\n 'keepalive': keepalive,\n 'configured_keepalive': configured_keepalive,\n 'active_prefix_count': active_prefix_count,\n 'received_prefix_count': received_prefix_count,\n 'accepted_prefix_count': accepted_prefix_count,\n 'suppressed_prefix_count': suppressed_prefix_count,\n 'advertised_prefix_count': advertised_prefix_count,\n 'flap_count': flap_count\n })\n\n return bgp_neighbors_detail\n\n def get_arp_table(self):\n\n arp_table = []\n\n rpc_command = '<Get><Operational><ARP></ARP></Operational></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for arp_entry in result_tree.xpath('.//EntryTable/Entry'):\n interface = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(arp_entry, './/InterfaceName'))\n ip = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(arp_entry, './/Address'))\n age = napalm_base.helpers.convert(float,\n napalm_base.helpers.find_txt(arp_entry, './/Age'), 0.0)\n mac_raw = napalm_base.helpers.find_txt(arp_entry, './/HardwareAddress')\n\n arp_table.append(\n {\n 'interface': interface,\n 'mac': napalm_base.helpers.mac(mac_raw),\n 'ip': napalm_base.helpers.ip(ip),\n 'age': age\n }\n )\n\n return arp_table\n\n def get_ntp_peers(self):\n\n ntp_peers = {}\n\n rpc_command = '<Get><Configuration><NTP></NTP></Configuration></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for version in ['IPV4', 'IPV6']:\n xpath = './/Peer{version}Table/Peer{version}'.format(version=version)\n for peer in result_tree.xpath(xpath):\n peer_type = napalm_base.helpers.find_txt(\n peer, 'PeerType{version}/Naming/PeerType'.format(version=version))\n if peer_type != 'Peer':\n continue\n peer_address = napalm_base.helpers.find_txt(\n peer, 'Naming/Address{version}'.format(version=version))\n if not peer_address:\n continue\n ntp_peers[peer_address] = {}\n\n return ntp_peers\n\n def get_ntp_servers(self):\n\n ntp_servers = {}\n\n rpc_command = '<Get><Configuration><NTP></NTP></Configuration></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for version in ['IPV4', 'IPV6']:\n xpath = './/Peer{version}Table/Peer{version}'.format(version=version)\n for peer in result_tree.xpath(xpath):\n peer_type = napalm_base.helpers.find_txt(\n peer, 'PeerType{version}/Naming/PeerType'.format(version=version))\n if peer_type != 'Server':\n continue\n server_address = napalm_base.helpers.find_txt(\n peer, 'Naming/Address{version}'.format(version=version))\n if not server_address:\n continue\n ntp_servers[server_address] = {}\n\n return ntp_servers\n\n def get_ntp_stats(self):\n\n ntp_stats = []\n\n rpc_command = '<Get><Operational><NTP><NodeTable></NodeTable></NTP></Operational></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n xpath = './/NodeTable/Node/Associations/PeerSummaryInfo/Entry/PeerInfoCommon'\n for node in result_tree.xpath(xpath):\n synchronized = eval(napalm_base.helpers.find_txt(node, 'IsSysPeer', 'false').title())\n address = napalm_base.helpers.find_txt(node, 'Address')\n if address == 'DLRSC node':\n continue\n referenceid = napalm_base.helpers.find_txt(node, 'ReferenceID')\n hostpoll = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(node, 'HostPoll', '0'))\n reachability = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(node, 'Reachability', '0'))\n stratum = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(node, 'Stratum', '0'))\n delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(node, 'Delay', '0.0'))\n offset = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(node, 'Offset', '0.0'))\n jitter = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(node, 'Dispersion', '0.0'))\n ntp_stats.append({\n 'remote': address,\n 'synchronized': synchronized,\n 'referenceid': referenceid,\n 'stratum': stratum,\n 'type': u'',\n 'when': u'',\n 'hostpoll': hostpoll,\n 'reachability': reachability,\n 'delay': delay,\n 'offset': offset,\n 'jitter': jitter\n })\n\n return ntp_stats\n\n def get_interfaces_ip(self):\n\n interfaces_ip = {}\n\n rpc_command_ipv4_ipv6 = '<Get><Operational><IPV4Network></IPV4Network>\\\n <IPV6Network></IPV6Network></Operational></Get>'\n\n # only one request\n ipv4_ipv6_tree = ETREE.fromstring(\n self.device.make_rpc_call(rpc_command_ipv4_ipv6))\n\n # parsing IPv4\n ipv4_xpath = './/IPV4Network/InterfaceTable/Interface'\n for interface in ipv4_ipv6_tree.xpath(ipv4_xpath):\n interface_name = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(interface, 'Naming/InterfaceName'))\n primary_ip = napalm_base.helpers.ip(napalm_base.helpers.find_txt(\n interface, 'VRFTable/VRF/Detail/PrimaryAddress'))\n primary_prefix = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(interface, 'VRFTable/VRF/Detail/PrefixLength'))\n if interface_name not in interfaces_ip.keys():\n interfaces_ip[interface_name] = {}\n if u'ipv4' not in interfaces_ip[interface_name].keys():\n interfaces_ip[interface_name][u'ipv4'] = {}\n if primary_ip not in interfaces_ip[interface_name].get(u'ipv4', {}).keys():\n interfaces_ip[interface_name][u'ipv4'][primary_ip] = {\n u'prefix_length': primary_prefix\n }\n for secondary_address in interface.xpath('VRFTable/VRF/Detail/SecondaryAddress/Entry'):\n secondary_ip = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(secondary_address, 'Address'))\n secondary_prefix = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(secondary_address, 'PrefixLength'))\n if secondary_ip not in interfaces_ip[interface_name]:\n interfaces_ip[interface_name][u'ipv4'][secondary_ip] = {\n u'prefix_length': secondary_prefix\n }\n\n # parsing IPv6\n ipv6_xpath = (\n './/IPV6Network/NodeTable/Node/InterfaceData'\n '/VRFTable/VRF/GlobalDetailTable/GlobalDetail'\n )\n for interface in ipv4_ipv6_tree.xpath(ipv6_xpath):\n interface_name = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(interface, 'Naming/InterfaceName'))\n if interface_name not in interfaces_ip.keys():\n interfaces_ip[interface_name] = {}\n if u'ipv6' not in interfaces_ip[interface_name].keys():\n interfaces_ip[interface_name][u'ipv6'] = {}\n for address in interface.xpath('AddressList/Entry'):\n address_ip = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(address, 'Address'))\n address_prefix = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(address, 'PrefixLength'))\n if address_ip not in interfaces_ip[interface_name].get(u'ipv6', {}).keys():\n interfaces_ip[interface_name][u'ipv6'][address_ip] = {\n u'prefix_length': address_prefix\n }\n\n return interfaces_ip\n\n def get_mac_address_table(self):\n\n mac_table = []\n\n rpc_command = '<Get><Operational><L2VPNForwarding></L2VPNForwarding></Operational></Get>'\n\n result_tree = ETREE.fromstring(self.device.make_rpc_call(rpc_command))\n\n for mac_entry in result_tree.xpath('.//L2FIBMACDetailTable/L2FIBMACDetail'):\n mac_raw = napalm_base.helpers.find_txt(mac_entry, 'Naming/Address')\n vlan = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(\n mac_entry, 'Naming/Name', '').replace('vlan', ''), 0)\n interface = napalm_base.helpers.find_txt(\n mac_entry, 'Segment/AC/InterfaceHandle', u'')\n\n mac_table.append({\n 'mac': napalm_base.helpers.mac(mac_raw),\n 'interface': interface,\n 'vlan': vlan,\n 'active': True,\n 'static': False,\n 'moves': 0,\n 'last_move': 0.0\n })\n\n return mac_table\n\n def get_route_to(self, destination='', protocol=''):\n\n routes = {}\n\n if not isinstance(destination, py23_compat.string_types):\n raise TypeError('Please specify a valid destination!')\n\n if not isinstance(protocol, py23_compat.string_types) or \\\n protocol.lower() not in ('static', 'bgp', 'isis'):\n raise TypeError(\"Protocol not supported: {protocol}.\".format(\n protocol=protocol\n ))\n\n protocol = protocol.lower()\n dest_split = destination.split('/')\n network = dest_split[0]\n prefix_tag = ''\n if len(dest_split) == 2:\n prefix_tag = '<PrefixLength>{prefix_length}</PrefixLength>'.format(\n prefix_length=dest_split[1])\n\n route_info_rpc_command = '<Get><Operational><RIB><VRFTable><VRF><Naming><VRFName>default\\\n </VRFName></Naming><AFTable><AF><Naming><AFName>IPv4</AFName></Naming><SAFTable><SAF>\\\n <Naming><SAFName>Unicast</SAFName></Naming><IP_RIBRouteTable><IP_RIBRoute><Naming>\\\n <RouteTableName>default</RouteTableName></Naming><RouteTable><Route><Naming><Address>\\\n {network}</Address>{prefix}</Naming></Route></RouteTable></IP_RIBRoute></IP_RIBRouteTable>\\\n </SAF></SAFTable></AF></AFTable></VRF></VRFTable></RIB></Operational></Get>'.format(\n network=network,\n prefix=prefix_tag\n )\n\n routes_tree = ETREE.fromstring(self.device.make_rpc_call(route_info_rpc_command))\n\n for route in routes_tree.xpath('.//Route'):\n route_protocol = napalm_base.helpers.convert(\n text_type, napalm_base.helpers.find_txt(route, 'ProtocolName').upper())\n if route_protocol.lower() != protocol:\n continue # ignore routes learned via a different protocol\n route_details = {}\n address = napalm_base.helpers.find_txt(route, 'Prefix')\n length = napalm_base.helpers.find_txt(route, 'PrefixLength')\n\n priority = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(route, 'Priority'))\n age = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(route, 'RouteAge'))\n destination = napalm_base.helpers.convert(\n text_type,\n '{prefix}/{length}'.format(\n prefix=address,\n length=length\n )\n )\n if destination not in routes.keys():\n routes[destination] = []\n\n route_details = {\n 'current_active': False,\n 'last_active': False,\n 'age': age,\n 'next_hop': u'',\n 'protocol': route_protocol,\n 'outgoing_interface': u'',\n 'preference': priority,\n 'selected_next_hop': False,\n 'inactive_reason': u'',\n 'routing_table': u'default',\n 'protocol_attributes': {}\n }\n\n # from BGP will try to get some more information\n if protocol.lower() == 'bgp':\n # looks like IOS-XR does not filter correctly\n # !IMPORTANT\n bgp_route_info_rpc_command = '<Get><Operational><BGP><Active><DefaultVRF><AFTable>\\\n <AF><Naming><AFName>IPv4Unicast</AFName></Naming><PathTable><Path><Naming><Network>\\\n <IPV4Address>{network}</IPV4Address><IPV4PrefixLength>{prefix_len}\\\n </IPV4PrefixLength></Network></Naming></Path></PathTable></AF></AFTable>\\\n </DefaultVRF></Active></BGP></Operational></Get>'.format(\n network=network,\n prefix_len=dest_split[-1]\n )\n bgp_route_tree = ETREE.fromstring(\n self.device.make_rpc_call(bgp_route_info_rpc_command))\n for bgp_path in bgp_route_tree.xpath('.//Path'):\n single_route_details = route_details.copy()\n if 'NotFound' not in bgp_path.keys():\n best_path = eval(napalm_base.helpers.find_txt(\n bgp_path, 'PathInformation/IsBestPath', 'false').title())\n local_preference = napalm_base.helpers.convert(\n int,\n napalm_base.helpers.find_txt(\n bgp_path,\n 'AttributesAfterPolicyIn/CommonAttributes/LocalPreference'\n ),\n 0\n )\n local_preference = napalm_base.helpers.convert(\n int,\n napalm_base.helpers.find_txt(\n bgp_path,\n 'AttributesAfterPolicyIn/CommonAttributes/LocalPreference',\n ),\n 0\n )\n remote_as = napalm_base.helpers.convert(\n int,\n napalm_base.helpers.find_txt(\n bgp_path,\n 'AttributesAfterPolicyIn/CommonAttributes/NeighborAS',\n ),\n 0\n )\n remote_address = napalm_base.helpers.ip(\n napalm_base.helpers.find_txt(\n bgp_path, 'PathInformation/NeighborAddress/IPV4Address') or\n napalm_base.helpers.find_txt(\n bgp_path, 'PathInformation/NeighborAddress/IPV6Address')\n )\n as_path = ' '.join(\n [\n bgp_as.text\n for bgp_as in bgp_path.xpath(\n 'AttributesAfterPolicyIn/CommonAttributes/NeighborAS/Entry')\n ]\n )\n next_hop = napalm_base.helpers.find_txt(\n bgp_path, 'PathInformation/NextHop/IPV4Address') \\\n or napalm_base.helpers.find_txt(\n bgp_path, 'PathInformation/NextHop/IPV6Address')\n single_route_details['current_active'] = best_path\n single_route_details['next_hop'] = next_hop\n single_route_details['protocol_attributes'] = {\n 'local_preference': local_preference,\n 'as_path': as_path,\n 'remote_as': remote_as,\n 'remote_address': remote_address\n }\n routes[destination].append(single_route_details)\n\n else:\n first_route = True\n for route_entry in route.xpath('RoutePath/Entry'):\n # get all possible entries\n next_hop = napalm_base.helpers.find_txt(route_entry, 'Address')\n single_route_details = route_details.copy()\n single_route_details.update({\n 'current_active': first_route,\n 'next_hop': next_hop\n })\n routes[destination].append(single_route_details)\n first_route = False\n\n return routes\n\n def get_snmp_information(self):\n\n snmp_information = {}\n\n snmp_rpc_command = '<Get><Configuration><SNMP></SNMP></Configuration></Get>'\n\n snmp_result_tree = ETREE.fromstring(self.device.make_rpc_call(snmp_rpc_command))\n\n _PRIVILEGE_MODE_MAP_ = {\n 'ReadOnly': u'ro',\n 'ReadWrite': u'rw'\n }\n\n snmp_information = {\n 'chassis_id': napalm_base.helpers.find_txt(snmp_result_tree, './/ChassisID'),\n 'contact': napalm_base.helpers.find_txt(snmp_result_tree, './/Contact'),\n 'location': napalm_base.helpers.find_txt(snmp_result_tree, './/Location'),\n 'community': {}\n }\n\n for community in snmp_result_tree.xpath('.//DefaultCommunity'):\n name = napalm_base.helpers.find_txt(community, 'Naming/CommunityName')\n privilege = napalm_base.helpers.find_txt(community, 'Priviledge')\n acl = napalm_base.helpers.find_txt(community, 'AccessList')\n snmp_information['community'][name] = {\n 'mode': _PRIVILEGE_MODE_MAP_.get(privilege, u''),\n 'acl': acl\n }\n\n return snmp_information\n\n def get_probes_config(self):\n\n sla_config = {}\n\n _PROBE_TYPE_XML_TAG_MAP_ = {\n 'ICMPEcho': u'icmp-ping',\n 'UDPEcho': u'udp-ping',\n 'ICMPJitter': u'icmp-ping-timestamp',\n 'UDPJitter': u'udp-ping-timestamp'\n }\n\n sla_config_rpc_command = '<Get><Configuration><IPSLA></IPSLA></Configuration></Get>'\n\n sla_config_result_tree = ETREE.fromstring(\n self.device.make_rpc_call(sla_config_rpc_command))\n\n for probe in sla_config_result_tree.xpath('.//Definition'):\n probe_name = napalm_base.helpers.find_txt(probe, 'Naming/OperationID')\n operation_type = probe.xpath('OperationType')[0].getchildren()[0].tag\n probe_type = _PROBE_TYPE_XML_TAG_MAP_.get(operation_type, u'')\n operation_xpath = 'OperationType/{op_type}'.format(op_type=operation_type)\n operation = probe.xpath(operation_xpath)[0]\n test_name = napalm_base.helpers.find_txt(operation, 'Tag')\n source = napalm_base.helpers.find_txt(operation, 'SourceAddress')\n target = napalm_base.helpers.find_txt(operation, 'DestAddress')\n test_interval = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(operation, 'Frequency', '0'))\n probe_count = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(operation, 'History/Buckets', '0'))\n if probe_name not in sla_config.keys():\n sla_config[probe_name] = {}\n if test_name not in sla_config[probe_name]:\n sla_config[probe_name][test_name] = {}\n sla_config[probe_name][test_name] = {\n 'probe_type': probe_type,\n 'source': source,\n 'target': target,\n 'probe_count': probe_count,\n 'test_interval': test_interval\n }\n\n return sla_config\n\n def get_probes_results(self):\n\n sla_results = {}\n\n _PROBE_TYPE_XML_TAG_MAP_ = {\n 'ICMPEcho': u'icmp-ping',\n 'UDPEcho': u'udp-ping',\n 'ICMPJitter': u'icmp-ping-timestamp',\n 'UDPJitter': u'udp-ping-timestamp'\n }\n\n sla_results_rpc_command = '<Get><Operational><IPSLA></IPSLA></Operational></Get>'\n\n sla_results_tree = ETREE.fromstring(\n self.device.make_rpc_call(sla_results_rpc_command))\n\n probes_config = self.get_probes_config() # need to retrieve also the configuration\n # source and tag/test_name not provided\n\n for probe in sla_results_tree.xpath('.//Operation'):\n probe_name = napalm_base.helpers.find_txt(probe, 'Naming/OperationID')\n test_name = list(probes_config.get(probe_name).keys())[0]\n target = napalm_base.helpers.find_txt(\n probe, 'History/Target/LifeTable/Life/BucketTable/Bucket[0]/TargetAddress\\\n /IPv4AddressTarget')\n source = probes_config.get(probe_name).get(test_name, {}).get('source', '')\n probe_type = _PROBE_TYPE_XML_TAG_MAP_.get(napalm_base.helpers.find_txt(\n probe, 'Statistics/Latest/Target/SpecificStats/op_type'))\n probe_count = probes_config.get(probe_name).get(test_name, {}).get('probe_count', 0)\n response_times = probe.xpath(\n 'History/Target/LifeTable/Life[last()]/BucketTable/Bucket/ResponseTime')\n response_times = [\n napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(response_time, '.', '0'))\n for response_time in response_times\n ]\n rtt = 0.0\n\n if len(response_times):\n rtt = sum(response_times, 0.0)/len(response_times)\n return_codes = probe.xpath(\n 'History/Target/LifeTable/Life[last()]/BucketTable/Bucket/ReturnCode')\n return_codes = [\n napalm_base.helpers.find_txt(return_code, '.')\n for return_code in return_codes\n ]\n\n last_test_loss = 0.0\n if len(return_codes):\n last_test_loss = napalm_base.helpers.convert(\n int, 100*(1-return_codes.count('ipslaRetCodeOK')/napalm_base.helpers.convert(\n float, len(return_codes))))\n rms = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe, 'Statistics/Aggregated/HourTable/Hour\\\n /Distributed/Target/DistributionIntervalTable/DistributionInterval/CommonStats\\\n /Sum2ResponseTime'))\n global_test_updates = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe, 'Statistics/Aggregated/HourTable/Hour\\\n /Distributed/Target/DistributionIntervalTable/DistributionInterval/CommonStats\\\n /UpdateCount'))\n\n jitter = 0.0\n if global_test_updates:\n jitter = rtt-(rms/global_test_updates)**0.5\n # jitter = max(rtt - max(response_times), rtt - min(response_times))\n current_test_min_delay = 0.0 # no stats for undergoing test :(\n current_test_max_delay = 0.0\n current_test_avg_delay = 0.0\n last_test_min_delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe,\n 'Statistics/Latest/Target/CommonStats/MinResponseTime'))\n last_test_max_delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe,\n 'Statistics/Latest/Target/CommonStats/MaxResponseTime'))\n last_test_sum_delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe,\n 'Statistics/Latest/Target/CommonStats/SumResponseTime'))\n last_test_updates = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe,\n 'Statistics/Latest/Target/CommonStats/UpdateCount'))\n last_test_avg_delay = 0.0\n if last_test_updates:\n last_test_avg_delay = last_test_sum_delay/last_test_updates\n global_test_min_delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe,\n 'Statistics/Aggregated/HourTable/Hour/Distributed/Target\\\n /DistributionIntervalTable/DistributionInterval/CommonStats/MinResponseTime'))\n global_test_max_delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe,\n 'Statistics/Aggregated/HourTable/Hour/Distributed/Target\\\n /DistributionIntervalTable/DistributionInterval/CommonStats/MaxResponseTime'))\n global_test_sum_delay = napalm_base.helpers.convert(\n float, napalm_base.helpers.find_txt(probe, 'Statistics/Aggregated/HourTable/Hour\\\n /Distributed/Target/DistributionIntervalTable/DistributionInterval\\\n /CommonStats/SumResponseTime'))\n global_test_avg_delay = 0.0\n if global_test_updates:\n global_test_avg_delay = global_test_sum_delay/global_test_updates\n if probe_name not in sla_results.keys():\n sla_results[probe_name] = {}\n sla_results[probe_name][test_name] = {\n 'target': target,\n 'source': source,\n 'probe_type': probe_type,\n 'probe_count': probe_count,\n 'rtt': rtt,\n 'round_trip_jitter': jitter,\n 'last_test_loss': last_test_loss,\n 'current_test_min_delay': current_test_min_delay,\n 'current_test_max_delay': current_test_max_delay,\n 'current_test_avg_delay': current_test_avg_delay,\n 'last_test_min_delay': last_test_min_delay,\n 'last_test_max_delay': last_test_max_delay,\n 'last_test_avg_delay': last_test_avg_delay,\n 'global_test_min_delay': global_test_min_delay,\n 'global_test_max_delay': global_test_max_delay,\n 'global_test_avg_delay': global_test_avg_delay\n }\n\n return sla_results\n\n def traceroute(self,\n destination,\n source=C.TRACEROUTE_SOURCE,\n ttl=C.TRACEROUTE_TTL,\n timeout=C.TRACEROUTE_TIMEOUT):\n\n traceroute_result = {}\n\n ipv = 4\n try:\n ipv = IPAddress(destination).version\n except AddrFormatError:\n return {'error': 'Wrong destination IP Address!'}\n\n source_tag = ''\n ttl_tag = ''\n timeout_tag = ''\n if source:\n source_tag = '<Source>{source}</Source>'.format(source=source)\n if ttl:\n ttl_tag = '<MaxTTL>{maxttl}</MaxTTL>'.format(maxttl=ttl)\n if timeout:\n timeout_tag = '<Timeout>{timeout}</Timeout>'.format(timeout=timeout)\n else:\n timeout = 5 # seconds\n\n traceroute_rpc_command = '<Set><Action><TraceRoute><IPV{version}><Destination>{destination}\\\n </Destination>{source_tag}{ttl_tag}{timeout_tag}</IPV{version}></TraceRoute></Action>\\\n </Set>'.format(\n version=ipv,\n destination=destination,\n source_tag=source_tag,\n ttl_tag=ttl_tag,\n timeout_tag=timeout_tag\n )\n\n xml_tree_txt = self.device.make_rpc_call(traceroute_rpc_command)\n traceroute_tree = ETREE.fromstring(xml_tree_txt)\n\n results_tree = traceroute_tree.xpath('.//Results')\n if results_tree is None or not len(results_tree):\n return {'error': 'Device returned empty results.'}\n\n results_error = napalm_base.helpers.find_txt(results_tree[0], 'Error')\n\n if results_error:\n return {'error': results_error}\n\n traceroute_result['success'] = {}\n\n last_hop_index = 1\n last_probe_index = 1\n last_probe_ip_address = '*'\n last_probe_host_name = ''\n last_hop_dict = {'probes': {}}\n\n for thanks_cisco in results_tree[0].getchildren():\n tag_name = thanks_cisco.tag\n tag_value = thanks_cisco.text\n if tag_name == 'HopIndex':\n new_hop_index = napalm_base.helpers.convert(\n int, napalm_base.helpers.find_txt(thanks_cisco, '.', '-1'))\n if last_hop_index and last_hop_index != new_hop_index:\n traceroute_result['success'][last_hop_index] = copy.deepcopy(last_hop_dict)\n last_hop_dict = {'probes': {}}\n last_probe_ip_address = '*'\n last_probe_host_name = ''\n last_hop_index = new_hop_index\n continue\n tag_value = napalm_base.helpers.find_txt(thanks_cisco, '.', '')\n if tag_name == 'ProbeIndex':\n last_probe_index = napalm_base.helpers.convert(int, tag_value, 0) + 1\n if last_probe_index not in last_hop_dict.get('probes').keys():\n last_hop_dict['probes'][last_probe_index] = {}\n if not last_probe_host_name:\n last_probe_host_name = last_probe_ip_address\n last_hop_dict['probes'][last_probe_index] = {\n 'ip_address': napalm_base.helpers.convert(\n text_type, last_probe_ip_address),\n 'host_name': napalm_base.helpers.convert(\n text_type, last_probe_host_name),\n 'rtt': timeout * 1000.0\n }\n continue\n if tag_name == 'HopAddress':\n last_probe_ip_address = tag_value\n continue\n if tag_name == 'HopHostName':\n last_probe_host_name = tag_value\n continue\n if tag_name == 'DeltaTime':\n last_hop_dict['probes'][last_probe_index]['rtt'] = napalm_base.helpers.convert(\n float, tag_value, 0.0)\n continue\n\n if last_hop_index:\n traceroute_result['success'][last_hop_index] = last_hop_dict\n\n return traceroute_result\n\n def get_users(self):\n\n users = {}\n\n _CISCO_GROUP_TO_CISCO_PRIVILEGE_MAP = {\n 'root-system': 15,\n 'operator': 5,\n 'sysadmin': 1,\n 'serviceadmin': 1,\n 'root-lr': 15\n }\n\n _DEFAULT_USER_DETAILS = {\n 'level': 0,\n 'password': '',\n 'sshkeys': []\n }\n\n users_xml_req = '<Get><Configuration><AAA></AAA></Configuration></Get>'\n\n users_xml_reply = ETREE.fromstring(self.device.make_rpc_call(users_xml_req))\n\n for user_entry in users_xml_reply.xpath('.//Username'):\n username = napalm_base.helpers.find_txt(user_entry, 'Naming/Name')\n group = napalm_base.helpers.find_txt(\n user_entry, 'UsergroupsUnderUsername/UsergroupUnderUsername/Naming/Name')\n level = _CISCO_GROUP_TO_CISCO_PRIVILEGE_MAP.get(group, 0)\n password = napalm_base.helpers.find_txt(user_entry, 'Password/Password')\n user_details = _DEFAULT_USER_DETAILS.copy()\n user_details.update({\n 'level': level,\n 'password': py23_compat.text_type(password)\n })\n users[username] = user_details\n\n return users\n\n def get_config(self, retrieve='all'):\n\n config = {\n 'startup': '',\n 'running': '',\n 'candidate': ''\n } # default values\n\n if retrieve.lower() in ['running', 'all']:\n config['running'] = py23_compat.text_type(\n self.device._execute_config_show('show running-config'))\n if retrieve.lower() in ['candidate', 'all']:\n config['candidate'] = py23_compat.text_type(\n self.device._execute_config_show('show configuration merge'))\n\n return config\n"},"domain":{"kind":"string","value":"codeparrot/github-code-clean"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":2279,"numItemsPerPage":100,"numTotalItems":228459,"offset":227900,"length":100}},"jwt":"eyJhbGciOiJFZERTQSIsImtpZCI6IjVHZDBvd0g5MTM2eDZjc1FvbE1zcktNWUZoRVFoUm5PVVVybEpjOUhaUEEifQ.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4NjkyMjQ4MywianRpIjoiOTY0ODAyMTctOGQxMy00MTZlLWI0ZTctYTE3NzU0Y2JhYjZiIiwic3ViIjoiL2RhdGFzZXRzL0phY2tCaW5hcnkvTWl4ZWRUZXh0LTIiLCJleHAiOjE3ODY5MjYwODMsImlzcyI6Imh0dHBzOi8vaHVnZ2luZ2ZhY2UuY28ifQ.di_htQ31XvkYCjQullEZyEJYELLv4TfrheDP4WSkm5yuoxgsk3sp0QeOb9KG0iQkGc0FCUKrC3K8-hgubYt7Cg","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":228459,"numBytesParquet":7695109915}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
text stringlengths 5.09k 178k | domain stringclasses 106
values |
|---|---|
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2007 Donald N. Allingham
# Copyright (C) 2009-2010 Gary Burton
# Copyright (C) 2010 Nick Hall
# Copyright (C) 2011 Tim G L Lyons
# Copyright (C) 2016 Paul R. Culley
#
# This program is free software; you can redistribute it and... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# Copyright (c) 2016-2021 Wintermute0110 <wintermute0110@gmail.com>
#
# 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; version 2 of the License.
#
# This program is distr... | codeparrot/github-code-clean |
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not... | codeparrot/github-code-clean |
# coding=utf-8
# Copyright 2021 The Fairseq Authors and the HuggingFace Inc. team. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/... | codeparrot/github-code-clean |
#
#
# Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Google Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
# 1. Redistributions of source code must retain the above copyright no... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
from south.utils import datetime_utils as datetime
from south.db import db
from south.v2 import SchemaMigration
from django.db import models
class Migration(SchemaMigration):
# Flag to indicate if this migration is too risky
# to run online and needs to be coordinated for offline
... | codeparrot/github-code-clean |
import os
import ast
import six
import json
import warnings
import logging
import copy
from unittest import TestCase
from CPAC.pipeline import nipype_pipeline_engine as pe
import nipype.interfaces.utility as util
from nipype.interfaces.utility import Rename
from CPAC.utils.interfaces.function import Function
from CPAC... | codeparrot/github-code-clean |
## This file is part of Invenio.
## Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 CERN.
##
## Invenio 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 2 of the
## Lic... | codeparrot/github-code-clean |
# This file was created automatically by SWIG 1.3.29.
# Don't modify this file, modify the SWIG interface instead.
import _windows_
import new
new_instancemethod = new.instancemethod
def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
if (name == "thisown"): return self.this.own(value)
if (name ... | codeparrot/github-code-clean |
# Copyright 2015 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | codeparrot/github-code-clean |
import os
from Tools.HardwareInfo import HardwareInfo
from Tools.BoundFunction import boundFunction
from config import config, ConfigSubsection, ConfigSelection, ConfigFloat, \
ConfigSatlist, ConfigYesNo, ConfigInteger, ConfigSubList, ConfigNothing, \
ConfigSubDict, ConfigOnOff, ConfigDateTime, ConfigText
from eni... | codeparrot/github-code-clean |
from __future__ import division, absolute_import, print_function
import collections
import tempfile
import sys
import os
import shutil
import warnings
import operator
import io
if sys.version_info[0] >= 3:
import builtins
else:
import __builtin__ as builtins
from decimal import Decimal
import numpy as np
fro... | codeparrot/github-code-clean |
# Copyright (C) 2012 Red Hat, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law ... | codeparrot/github-code-clean |
# Copyright 2014 Scalyr Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, so... | codeparrot/github-code-clean |
# encoding=UTF8
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You m... | codeparrot/github-code-clean |
""" Test functions for linalg module
"""
from __future__ import division, absolute_import, print_function
import os
import sys
import itertools
import traceback
import textwrap
import subprocess
import pytest
import numpy as np
from numpy import array, single, double, csingle, cdouble, dot, identity, matmul
from num... | codeparrot/github-code-clean |
__all__ = ['ReferenceFrame', 'Vector', 'Dyadic', 'dynamicsymbols',
'MechanicsStrPrinter', 'MechanicsPrettyPrinter',
'MechanicsLatexPrinter']
from sympy import (
Matrix, Symbol, sin, cos, eye, trigsimp, diff, sqrt, sympify,
expand, zeros, Derivative, Function, symbols, Add,
solve, S)
f... | codeparrot/github-code-clean |
#
# Copyright (c) 2013 Big Switch Networks, Inc.
#
# Licensed under the Eclipse Public License, Version 1.0 (the
# "License"); you may not use this file except in compliance with the
# License. You may obtain a copy of the License at
#
# http://www.eclipse.org/legal/epl-v10.html
#
# Unless required by applicable l... | codeparrot/github-code-clean |
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
Bottle is a fast and simple micro-framework for small web applications. It
offers request dispatching (Routes) with url parameter support, templates,
a built-in HTTP Server and adapters for many third party WSGI/HTTP-server and
template engines - all in a single file an... | codeparrot/github-code-clean |
# Copyright (C) 2014 Nippon Telegraph and Telephone Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by appli... | codeparrot/github-code-clean |
from __future__ import absolute_import
from __future__ import print_function
from typing import (
AbstractSet, Any, AnyStr, Callable, Dict, Iterable, Mapping, MutableMapping,
Optional, Sequence, Set, Text, Tuple, TypeVar, Union
)
from django.utils.html import escape
from django.utils.translation import ugettex... | codeparrot/github-code-clean |
"""
There are three types of functions implemented in SymPy:
1) defined functions (in the sense that they can be evaluated) like
exp or sin; they have a name and a body:
f = exp
2) undefined function which have a name but no body. Undefined
functions can be defined using a Function cla... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# -*- coding: utf-8 -*-
"""
GIS Controllers
"""
module = request.controller
resourcename = request.function
# Compact JSON encoding
SEPARATORS = (",", ":")
# -----------------------------------------------------------------------------
def index():
"""
Module's Home Page: Show... | codeparrot/github-code-clean |
# -*- coding:utf-8 -*-
"""
通联数据
Created on 2015/08/24
@author: Jimmy Liu
@group : waditu
@contact: jimmysoa@sina.cn
"""
from pandas.compat import StringIO
import pandas as pd
from tushare.util import vars as vs
from tushare.util.common import Client
from tushare.util import upass as up
class Macro():
def __... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
"""
The BaseCase class is the main gateway for using The SeleniumBase Framework.
It inherits Python's unittest.TestCase class, and runs with Pytest or Nose.
All tests using BaseCase automatically launch WebDriver browsers for tests.
Usage:
from seleniumbase import BaseCase
class MyTest... | codeparrot/github-code-clean |
#===- cindex.py - Python Indexing Library Bindings -----------*- python -*--===#
#
# The LLVM Compiler Infrastructure
#
# This file is distributed under the University of Illinois Open Source
# License. See LICENSE.TXT for details.
#
#===--------------------------------------------------------------... | codeparrot/github-code-clean |
# pylint: skip-file
# -*- coding: utf-8 -*-
# Author: asciidisco
# Module: default
# Created on: 13.01.2017
# License: MIT https://goo.gl/5bMj3H
"""Netflix API management"""
import os
import sys
import json
from time import time
try:
from urllib.parse import quote, unquote
except ImportError:
from urllib imp... | codeparrot/github-code-clean |
## NIFTY (Numerical Information Field Theory) has been developed at the
## Max-Planck-Institute for Astrophysics.
##
## Copyright (C) 2015 Max-Planck-Society
##
## Author: Marco Selig
## Project homepage: <http://www.mpa-garching.mpg.de/ift/nifty/>
##
## This program is free software: you can redistribute it and/or mod... | codeparrot/github-code-clean |
"""PiecewiseFunction for piecewise functions."""
import bisect
import numbers
import operator
from functools import partial
from integration import *
from interpolation import *
from utils import epsunique, estimateDegreeOfPole, testPole, findinv, estimateTailExponent, is_instance_method
import params
from numpy im... | codeparrot/github-code-clean |
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# ******************************************************************************
# * Software: FPDF for python *
# * Version: 1.54b *
# * Date: 2010-09-10 ... | codeparrot/github-code-clean |
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not u... | codeparrot/github-code-clean |
#!/usr/bin/env python
import os
import sys
import re
import gc
import locale
import shutil
import time
import unittest
import doctest
import operator
import subprocess
import tempfile
import traceback
import warnings
try:
import platform
IS_PYPY = platform.python_implementation() == 'PyPy'
IS_CPYTHON = pl... | codeparrot/github-code-clean |
import Image, ImageDraw
import ImageWin
import os
import wx
import wx.lib.masked as masked
import wx.lib.scrolledpanel as scrolled
import wx.lib.hyperlink as hl
import sys
import pickle
ID_ABOUT=1101
ID_OPEN=1102
ID_EXIT=1110
ID_INPUT=7001
ID_OUTPUT=7002
ID_EDIT_GOOD = 7003
ID_EDIT_CAP = 7004
ID_EDIT_FA... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# Relational database models for Montage
import json
import time
import random
import string
import datetime
import itertools
from collections import Counter, defaultdict
from math import ceil
from pyvotecore.schulze_npr import SchulzeNPR
from sqlalchemy import (Text,
C... | codeparrot/github-code-clean |
## @package csnGUI
# Definition of main application CSnakeGUIApp.
#!/usr/bin/env python
# -*- coding: iso-8859-1 -*-
import wxversion
import sys
if not getattr(sys, 'frozen', False):
wxversion.select('2.8')
from wx import xrc
import csnGUIHandler
import csnGUIOptions
import csnContext
import csnProject
from csnL... | codeparrot/github-code-clean |
"""
=====================================================
Distance computations (:mod:`scipy.spatial.distance`)
=====================================================
.. sectionauthor:: Damian Eads
Function Reference
------------------
Distance matrix computation from a collection of raw observation vectors
stored in... | codeparrot/github-code-clean |
"""
@package mi.instrument.seabird.sbe16plus_v2.ctdpf_jb.test.test_driver
@file marine-integrations/mi/instrument/seabird/sbe16plus_v2/ctdpf_jb/driver.py
@author Tapana Gupta
@brief Test cases for ctdpf_jb driver
USAGE:
Make tests verbose and provide stdout
* From the IDK
$ bin/test_driver
$ bin/test... | codeparrot/github-code-clean |
"""
Tests for Shopping Cart views
"""
from collections import OrderedDict
import pytz
from urlparse import urlparse
from decimal import Decimal
import json
from django.http import HttpRequest
from django.conf import settings
from django.test import TestCase
from django.test.utils import override_settings
from django.c... | codeparrot/github-code-clean |
#Copyright ReportLab Europe Ltd. 2000-2012
#see license.txt for license details
__version__=''' $Id$ '''
__doc__="""
The Canvas object is the primary interface for creating PDF files. See
doc/reportlab-userguide.pdf for copious examples.
"""
__all__ = ['Canvas']
ENABLE_TRACKING = 1 # turn this off to do profile testin... | codeparrot/github-code-clean |
"""This submodule contains the class definitions of the the main five classes
svgpathtools is built around: Path, Line, QuadraticBezier, CubicBezier, and
Arc."""
# External dependencies
from __future__ import division, absolute_import, print_function
import re
try:
from collections.abc import MutableSequence # no... | codeparrot/github-code-clean |
from plotly.basedatatypes import BaseTraceType as _BaseTraceType
import copy as _copy
class Funnel(_BaseTraceType):
# class properties
# --------------------
_parent_path_str = ""
_path_str = "funnel"
_valid_props = {
"alignmentgroup",
"cliponaxis",
"connector",
"c... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
from __future__ import division
import numpy as np
from library import gibbs
from absolute_salinity_sstar_ct import CT_from_t
from gsw.utilities import match_args_return, strip_mask
from constants import Kelvin, db2Pascal, P0, SSO, cp0, R, sfac
from conversions import pt_from_CT, pt_from_t, p... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
from Tools.Profile import profile
from Screen import Screen
import Screens.InfoBar
import Components.ParentalControl
from Components.Button import Button
from Components.Renderer.Picon import getPiconName
from Components.ServiceList import ServiceList, refreshServiceList
from Components.ActionMa... | codeparrot/github-code-clean |
# Author: Nic Wolfe <nic@wolfeden.ca>
# URL: http://code.google.com/p/sickbeard/
#
# This file is part of SickGear.
#
# SickGear 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... | codeparrot/github-code-clean |
#!/usr/bin/env python
'''
setup board.h for chibios
'''
import argparse, sys, fnmatch, os, dma_resolver, shlex, pickle, re
import shutil
parser = argparse.ArgumentParser("chibios_pins.py")
parser.add_argument(
'-D', '--outdir', type=str, default=None, help='Output directory')
parser.add_argument(
'--bootloade... | codeparrot/github-code-clean |
#!/usr/bin/env python
## Neeme Takis added speed control via default variables 24.8.2015
#
# Copyright 2012 Jonas Berg
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# ... | codeparrot/github-code-clean |
# Orca
#
# Copyright 2004-2009 Sun Microsystems Inc.
# Copyright 2010-2013 The Orca Team
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your... | codeparrot/github-code-clean |
##############################################################################
##
## This file is part of Sardana
##
## http://www.sardana-controls.org/
##
## Copyright 2011 CELLS / ALBA Synchrotron, Bellaterra, Spain
##
## Sardana is free software: you can redistribute it and/or modify
## it under the terms of the GN... | codeparrot/github-code-clean |
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not us... | codeparrot/github-code-clean |
import logging
import time
from globus_sdk import exc
from globus_sdk.base import BaseClient, merge_params, safe_stringify
from globus_sdk.transfer.paging import PaginatedResource
from globus_sdk.transfer.response import (
ActivationRequirementsResponse,
IterableTransferResponse,
TransferResponse,
)
logge... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# transformations.py
# Copyright (c) 2006-2015, Christoph Gohlke
# Copyright (c) 2006-2015, The Regents of the University of California
# Produced at the Laboratory for Fluorescence Dynamics
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modifica... | codeparrot/github-code-clean |
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use ... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# Copyright (c) 2013 OpenStack Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by appl... | codeparrot/github-code-clean |
import json
import os
from datetime import datetime, timedelta
from urllib.parse import quote, urlencode
from django.conf import settings
from django.core import mail
from django.core.files.storage import default_storage as storage
from django.test import RequestFactory
from django.urls import reverse
from django.uti... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
import json
import time
import urlparse
from datetime import datetime, timedelta
from django.conf import settings
from django.core import mail
from django.core.files import temp
from django.core.files.base import File as DjangoFile
from django.utils.datastructures import SortedDict
from django.... | codeparrot/github-code-clean |
"""
Module contains tools for processing Stata files into DataFrames
The StataReader below was originally written by Joe Presbrey as part of PyDTA.
It has been extended and improved by Skipper Seabold from the Statsmodels
project who also developed the StataWriter and was finally added to pandas in
a once again improv... | codeparrot/github-code-clean |
# Docstrings for generated ufuncs
#
# The syntax is designed to look like the function add_newdoc is being
# called from numpy.lib, but in this file add_newdoc puts the
# docstrings in a dictionary. This dictionary is used in
# _generate_pyx.py to generate the docstrings for the ufuncs in
# scipy.special at the C level... | codeparrot/github-code-clean |
#
# @BEGIN LICENSE
#
# Psi4: an open-source quantum chemistry software package
#
# Copyright (c) 2007-2022 The Psi4 Developers.
#
# The copyrights for code used from other parties are included in
# the corresponding files.
#
# This file is part of Psi4.
#
# Psi4 is free software; you can redistribute it and/or modify
#... | codeparrot/github-code-clean |
# Copyright 2015 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | codeparrot/github-code-clean |
# Copyright (c) 2005 Divmod, Inc.
# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Tests for L{twisted.protocols.amp}.
"""
from __future__ import absolute_import, division
import datetime
import decimal
from zope.interface import implementer
from zope.interface.verify import verifyClass, ... | codeparrot/github-code-clean |
"""Filter design.
"""
from __future__ import division, print_function, absolute_import
import math
import operator
import warnings
import numpy
import numpy as np
from numpy import (atleast_1d, poly, polyval, roots, real, asarray,
resize, pi, absolute, logspace, r_, sqrt, tan, log10,
... | codeparrot/github-code-clean |
"""scons.Node.FS
File system nodes.
These Nodes represent the canonical external objects that people think
of when they think of building software: files and directories.
This holds a "default_fs" variable that should be initialized with an FS
that can be used by scripts or modules looking for the canonical default.... | codeparrot/github-code-clean |
from compiler import *
####################################################################################################################
# Each scene prop record contains the following fields:
# 1) Scene prop id: used for referencing scene props in other files. The prefix spr_ is automatically added before each s... | codeparrot/github-code-clean |
#!/usr/bin/python
# -*- coding: utf-8 -*-
"""pefile, Portable Executable reader module
All the PE file basic structures are available with their default names as
attributes of the instance returned.
Processed elements such as the import table are made available with lowercase
names, to differentiate them from the upp... | codeparrot/github-code-clean |
#!/bin/bash
# This module contains custom HODModels, which are subclasses of Halotools implementations.
import numpy as np
from scipy.special import erf
from scipy.interpolate import interp1d
import warnings
from halotools.empirical_models import Zheng07Cens, Zheng07Sats, OccupationComponent, model_defaults
#from hal... | codeparrot/github-code-clean |
# ##### BEGIN GPL LICENSE BLOCK #####
#
# 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 2
# of the License, or (at your option) any later version.
#
# This program is distrib... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
from Screens.ChannelSelection import ChannelSelection, BouquetSelector, SilentBouquetSelector, EpgBouquetSelector
from Components.About import about
from Components.ActionMap import ActionMap, HelpableActionMap, NumberActionMap, HelpableNumberActionMap
from Components.Harddisk import harddiskm... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
#
# This file is part of the python-chess library.
# Copyright (C) 2012-2018 Niklas Fiekas <niklas.fiekas@backscattering.de>
#
# 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 Foundat... | codeparrot/github-code-clean |
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# This is unit with tests for LDAP access checks
from __future__ import print_function
import optparse
import sys
import base64
import re
sys.path.insert(0, "bin/python")
import samba
from samba.tests.subunitrun import SubunitOptions, TestProgram
import samba.getopt as o... | codeparrot/github-code-clean |
# Certain dictionaries below use data from PKHeX's Resources text files
species = {
1: 'Bulbasaur',
2: 'Ivysaur',
3: 'Venusaur',
4: 'Charmander',
5: 'Charmeleon',
6: 'Charizard',
7: 'Squirtle',
8: 'Wartortle',
9: 'Blastoise',
10: 'Caterpie',
11: 'Metapod',
12: 'Butterfre... | codeparrot/github-code-clean |
sample = """{
"content": [
{
"id": "zombie.survival.craft.z",
"title": "Last Day on Earth: Survival",
"icon": "https://lh3.googleusercontent.com/rCkmsTR5SRXnAfD_tpJpAJycYbsQW2tApoREMHs8sKwD9E1HCsW2C18lj7EQXiYGAAA",
"developer": "K-MOBILE",
"... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
import time
from collections import OrderedDict
from openerp import api, fields, models, _
from openerp.osv import expression
from openerp.exceptions import RedirectWarning, UserError, ValidationError
from openerp.tools.misc import formatLang
from openerp.tools import float_is_zero, float_compa... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2004-2010 Tiny SPRL (<http://tiny.be>).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# Copyright 2013 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless require... | codeparrot/github-code-clean |
from __future__ import unicode_literals
from __future__ import with_statement
from copy import deepcopy
from datetime import datetime
import logging
from time import mktime
import warnings
from wsgiref.handlers import format_date_time
import django
from django.conf import settings
from django.conf.urls import patterns... | codeparrot/github-code-clean |
## This file is part of Invenio.
## Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011 CERN.
##
## Invenio 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 2 of the
## License, or (at your ... | codeparrot/github-code-clean |
positions = {
'MIMAT0000062' : "hs9 94175957 94176036",
'MIMAT0000062' : "hs11 122146522 122146593",
'MIMAT0000062' : "hs22 46112749 46112822",
'MIMAT0000063' : "hs22 46113686 46113768",
'MIMAT0000064' : "hs21 16539828 16539911",
'MIMAT0000065' : "hs9 94178834 94178920",
'MIMAT0000066' : "hs19 51692786 51692864",
'MIMA... | codeparrot/github-code-clean |
# Copyright (c) Jean-Paul Calderone
# See LICENSE file for details.
"""
Unit tests for :py:mod:`OpenSSL.crypto`.
"""
from unittest import main
from warnings import catch_warnings, simplefilter
import base64
import os
import re
from subprocess import PIPE, Popen
from datetime import datetime, timedelta
import pytest... | codeparrot/github-code-clean |
# Author: Nic Wolfe <nic@wolfeden.ca>
# URL: http://code.google.com/p/sickbeard/
#
# This file is part of Sick Beard.
#
# Sick Beard 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 Lice... | codeparrot/github-code-clean |
"""Forest of trees-based ensemble methods
Those methods include random forests and extremely randomized trees.
The module structure is the following:
- The ``BaseForest`` base class implements a common ``fit`` method for all
the estimators in the module. The ``fit`` method of the base ``Forest``
class calls the ... | codeparrot/github-code-clean |
"""
numpy.ma : a package to handle missing or invalid values.
This package was initially written for numarray by Paul F. Dubois
at Lawrence Livermore National Laboratory.
In 2006, the package was completely rewritten by Pierre Gerard-Marchant
(University of Georgia) to make the MaskedArray class a subclass of ndarray,... | codeparrot/github-code-clean |
import datetime
import sqlalchemy as sa
from sqlalchemy import and_
from sqlalchemy import exc
from sqlalchemy import ForeignKey
from sqlalchemy import ForeignKeyConstraint
from sqlalchemy import func
from sqlalchemy import inspect
from sqlalchemy import Integer
from sqlalchemy import MetaData
from sqlalchemy import s... | codeparrot/github-code-clean |
from p4.tree import Tree
from p4.node import Node
from p4.func import read
from p4.var import var
from p4.p4exceptions import P4Error
import sys
import csv
import operator
import time
multiProcessing = False
try:
from multiprocessing import Process as Process
from multiprocessing import Queue, cpu_count
... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
import atexit
import json
import math
import os
import re
import six
from collections import namedtuple
from datetime import date
from math import ceil
from tempfile import NamedTemporaryFile
from wait_for import TimedOutError, wait_for
from cached_property import cached_property
from jsmin imp... | codeparrot/github-code-clean |
# Copyright 2015 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | codeparrot/github-code-clean |
# Copyright 2015 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applica... | codeparrot/github-code-clean |
# Copyright 2010 United States Government as represented by the
# Administrator of the National Aeronautics and Space Administration.
# Copyright 2011 Piston Cloud Computing, Inc.
# Copyright 2012-2013 Red Hat, Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# ... | codeparrot/github-code-clean |
"""blocking adapter test"""
from datetime import datetime
import functools
import logging
import socket
import threading
import time
import unittest
import uuid
import pika
from pika.adapters import blocking_connection
from pika.compat import as_bytes
import pika.connection
import pika.exceptions
from ..forward_serve... | codeparrot/github-code-clean |
import os
import re
import sys
import imp
import copy
import glob
import atexit
import tempfile
import subprocess
import shutil
import distutils
from distutils.errors import DistutilsError
try:
set
except NameError:
from sets import Set as set
from numpy.distutils.compat import get_exception
__all__ = ['Con... | codeparrot/github-code-clean |
#!/usr/bin/python
"""Sensorian_Client.py: Collects sensor data on given intervals and sends it to various services upon request.
Cab be run on its own or imported to other projects and run in the background.
"""
from __future__ import print_function
import ConfigParser
import os
import requests
import json
import ti... | codeparrot/github-code-clean |
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not us... | codeparrot/github-code-clean |
# Author: Teon Brooks <teon.brooks@gmail.com>
# Stefan Appelhoff <stefan.appelhoff@mailbox.org>
#
# License: BSD (3-clause)
from itertools import chain
import os
import os.path as op
import pytest
import numpy as np
from functools import partial
from string import ascii_lowercase
from numpy.testing import (... | codeparrot/github-code-clean |
#!/usr/bin/env python
# Copyright 2013 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""This is a simple HTTP/FTP/TCP/UDP/BASIC_AUTH_PROXY/WEBSOCKET server used for
testing Chrome.
It supports several test URLs, as spec... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
""" Framework for filtered REST requests
@copyright: 2013-14 (c) Sahana Software Foundation
@license: MIT
@requires: U{B{I{gluon}} <http://web2py.com>}
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentati... | codeparrot/github-code-clean |
import copy
from direct.controls.GravityWalker import GravityWalker
from direct.directnotify import DirectNotifyGlobal
from direct.distributed import DistributedObject
from direct.distributed import DistributedSmoothNode
from direct.distributed.ClockDelta import *
from direct.distributed.MsgTypes import *
from direct.f... | codeparrot/github-code-clean |
"""Pexpect is a Python module for spawning child applications and controlling
them automatically. Pexpect can be used for automating interactive applications
such as ssh, ftp, passwd, telnet, etc. It can be used to a automate setup
scripts for duplicating software package installations on different servers. It
can be u... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
version = "0.1.8"
# This file is part of EventGhost.
# Copyright (C) 2008-2013 Pako <lubos.ruckl@quick.cz>
#
# EventGhost 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 versio... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
#
# blitz_gateway - python bindings and wrappers to access an OMERO blitz server
#
# Copyright (c) 2007, 2010 Glencoe Software, Inc. All rights reserved.
#
# This software is distributed under the terms described by the LICENCE file
# you can find at the root of the distribution bundle, which ... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
##############################################################################
#
# OpenERP, Open Source Management Solution
# Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU... | codeparrot/github-code-clean |
# -*- coding: utf-8 -*-
# Copyright 2015 Spotify AB. All rights reserved.
#
# The contents of this file are licensed under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with the
# License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICE... | codeparrot/github-code-clean |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.