Class Remote

python/collaboration/remote.py:13–734

Class representing a connection to a Collaboration server

class Remote:
	"""
	Class representing a connection to a Collaboration server
	"""
	def __init__(self, handle: core.BNRemoteHandle):
		"""
		:param handle: FFI handle for internal use
		:raises: RuntimeError if there was an error
		"""

		self._handle = ctypes.cast(handle, core.BNRemoteHandle)

	def __del__(self):
		if core is not None:
			core.BNFreeRemote(self._handle)

	def __eq__(self, other):
		if not isinstance(other, Remote):
			return False
		if not self.has_loaded_metadata or not other.has_loaded_metadata:
			# Don't pull metadata if we haven't yet
			return self.address == other.address
		return other.unique_id == self.unique_id

	def __str__(self):
		return f'<remote: {self.name}>'

	def __repr__(self):
		return f'<remote: {self.name}>'

	@staticmethod
	def get_for_local_database(database: 'binaryninja.Database') -> Optional['Remote']:
		"""
		Get the Remote for a Database

		:param database: BN database, potentially with collaboration metadata
		:return: Remote from one of the connected remotes, or None if not found
		:rtype: Optional[Remote]
		:raises RuntimeError: If there was an error
		"""
		return databasesync.get_remote_for_local_database(database)

	@staticmethod
	def get_for_bv(bv: 'binaryninja.BinaryView') -> Optional['Remote']:
		"""
		Get the Remote for a Binary View

		:param bv: Binary view, potentially with collaboration metadata
		:return: Remote from one of the connected remotes, or None if not found
		:raises RuntimeError: If there was an error
		"""
		if not bv.file.has_database:
			return None
		db = bv.file.database
		if db is None:
			return None
		return databasesync.get_remote_for_local_database(db)