9 Commits

Author SHA1 Message Date
LIAUD Corentin
c85c76228d chore: version v2.1.12 2025-05-01 12:49:35 +02:00
LIAUD Corentin
e91a35b3ff chore: remove useless .cargo/config.toml file 2025-05-01 12:48:44 +02:00
LIAUD Corentin
8f979eff91 chore: improve pyadb_client README.md 2025-05-01 12:48:44 +02:00
LIAUD Corentin
af51584736 fix: #108 2025-05-01 12:48:44 +02:00
LIAUD Corentin
864bde01f6 feat: add zero-length packet if final_packet_size % endpoint_max_packet_size == 0 2025-05-01 12:48:44 +02:00
LIAUD Corentin
8361a0fe06 fix: implement Drop for USBTransport 2025-05-01 12:48:44 +02:00
LIAUD Corentin
218ec3d679 feat: add more trace info 2025-05-01 12:48:44 +02:00
LIAUD Corentin
4b817c0435 chore: remove unused feature 2025-05-01 12:48:44 +02:00
Ricardo Fernández Serrata
2dd30931f2 docs(logger): setup_logger safety assumptions (#107) 2025-04-22 08:59:23 +02:00
9 changed files with 92 additions and 53 deletions

View File

@@ -1,2 +0,0 @@
[target.aarch64-apple-darwin]
rustflags = ["-C", "link-arg=-undefined", "-C", "link-arg=dynamic_lookup"]

View File

@@ -9,7 +9,7 @@ homepage = "https://github.com/cocool97/adb_client"
keywords = ["adb", "android", "tcp", "usb"]
license = "MIT"
repository = "https://github.com/cocool97/adb_client"
version = "2.1.11"
version = "2.1.12"
# To build locally when working on a new release
[patch.crates-io]

View File

@@ -25,9 +25,15 @@ use std::path::Path;
use utils::setup_logger;
fn main() -> Result<()> {
// This depends on `clap`
let opts = Opts::parse();
setup_logger(opts.debug);
// SAFETY:
// We are assuming the entire process is single-threaded
// at this point.
// This seems true for the current version of `clap`,
// but there's no guarantee for future updates
unsafe { setup_logger(opts.debug) };
// Directly handling methods / commands that aren't linked to [`ADBDeviceExt`] trait.
// Other methods just have to create a concrete [`ADBDeviceExt`] instance, and return it.

View File

@@ -1,4 +1,8 @@
pub fn setup_logger(debug: bool) {
/// # Safety
///
/// This conditionally mutates the process' environment.
/// See [`std::env::set_var`] for more info.
pub unsafe fn setup_logger(debug: bool) {
// RUST_LOG variable has more priority then "--debug" flag
if std::env::var("RUST_LOG").is_err() {
let level = match debug {

View File

@@ -1,7 +1,5 @@
use std::{fs::File, path::Path};
use rand::Rng;
use crate::{
ADBMessageTransport, Result,
device::{MessageWriter, adb_message_device::ADBMessageDevice},
@@ -16,15 +14,11 @@ impl<T: ADBMessageTransport> ADBMessageDevice<T> {
let file_size = apk_file.metadata()?.len();
let mut rng = rand::rng();
let local_id = rng.random();
self.open_session(format!("exec:cmd package 'install' -S {}\0", file_size).as_bytes())?;
let transport = self.get_transport().clone();
let mut writer = MessageWriter::new(transport, local_id, self.get_remote_id()?);
let mut writer = MessageWriter::new(transport, self.get_local_id()?, self.get_remote_id()?);
std::io::copy(&mut apk_file, &mut writer)?;

View File

@@ -15,6 +15,7 @@ use crate::{
struct Endpoint {
iface: u8,
address: u8,
max_packet_size: usize,
}
/// Transport running on USB
@@ -111,6 +112,7 @@ impl USBTransport {
let endpoint = Endpoint {
iface: interface_desc.interface_number(),
address: endpoint_desc.address(),
max_packet_size: endpoint_desc.max_packet_size() as usize,
};
match endpoint_desc.direction() {
Direction::In => {
@@ -136,6 +138,34 @@ impl USBTransport {
Err(RustADBError::USBNoDescriptorFound)
}
fn write_bulk_data(&self, data: &[u8], timeout: Duration) -> Result<()> {
let endpoint = self.get_write_endpoint()?;
let handle = self.get_raw_connection()?;
let max_packet_size = endpoint.max_packet_size;
let mut offset = 0;
let data_len = data.len();
while offset < data_len {
let end = (offset + max_packet_size).min(data_len);
let write_amount = handle.write_bulk(endpoint.address, &data[offset..end], timeout)?;
offset += write_amount;
log::trace!(
"wrote chunk of size {} - {}/{}",
write_amount,
offset,
data_len
)
}
if offset % max_packet_size == 0 {
log::trace!("must send final zero-length packet");
handle.write_bulk(endpoint.address, &[], timeout)?;
}
Ok(())
}
}
impl ADBTransport for USBTransport {
@@ -145,9 +175,11 @@ impl ADBTransport for USBTransport {
let (read_endpoint, write_endpoint) = self.find_endpoints(&device)?;
Self::configure_endpoint(&device, &read_endpoint)?;
log::debug!("got read endpoint: {:?}", read_endpoint);
self.read_endpoint = Some(read_endpoint);
Self::configure_endpoint(&device, &write_endpoint)?;
log::debug!("got write endpoint: {:?}", write_endpoint);
self.write_endpoint = Some(write_endpoint);
self.handle = Some(Arc::new(device));
@@ -157,7 +189,21 @@ impl ADBTransport for USBTransport {
fn disconnect(&mut self) -> crate::Result<()> {
let message = ADBTransportMessage::new(MessageCommand::Clse, 0, 0, &[]);
self.write_message(message)
if let Err(e) = self.write_message(message) {
log::error!("error while sending CLSE message: {e}");
}
if let Some(handle) = &self.handle {
let endpoint = self.read_endpoint.as_ref().or(self.write_endpoint.as_ref());
if let Some(endpoint) = &endpoint {
match handle.release_interface(endpoint.iface) {
Ok(_) => log::debug!("succesfully released interface"),
Err(e) => log::error!("error while release interface: {e}"),
}
}
}
Ok(())
}
}
@@ -167,29 +213,15 @@ impl ADBMessageTransport for USBTransport {
message: ADBTransportMessage,
timeout: Duration,
) -> Result<()> {
let endpoint = self.get_write_endpoint()?;
let handle = self.get_raw_connection()?;
let message_bytes = message.header().as_bytes()?;
let mut total_written = 0;
loop {
total_written +=
handle.write_bulk(endpoint.address, &message_bytes[total_written..], timeout)?;
if total_written == message_bytes.len() {
break;
}
}
self.write_bulk_data(&message_bytes, timeout)?;
log::trace!("successfully write header: {} bytes", message_bytes.len());
let payload = message.into_payload();
if !payload.is_empty() {
let mut total_written = 0;
loop {
total_written +=
handle.write_bulk(endpoint.address, &payload[total_written..], timeout)?;
if total_written == payload.len() {
break;
}
}
self.write_bulk_data(&payload, timeout)?;
log::trace!("successfully write payload: {} bytes", payload.len());
}
Ok(())
@@ -198,29 +230,26 @@ impl ADBMessageTransport for USBTransport {
fn read_message_with_timeout(&mut self, timeout: Duration) -> Result<ADBTransportMessage> {
let endpoint = self.get_read_endpoint()?;
let handle = self.get_raw_connection()?;
let max_packet_size = endpoint.max_packet_size;
let mut data = [0; 24];
let mut total_read = 0;
loop {
total_read += handle.read_bulk(endpoint.address, &mut data[total_read..], timeout)?;
if total_read == data.len() {
break;
}
let mut data = [0u8; 24];
let mut offset = 0;
while offset < data.len() {
let end = (offset + max_packet_size).min(data.len());
let chunk = &mut data[offset..end];
offset += handle.read_bulk(endpoint.address, chunk, timeout)?;
}
let header = ADBTransportMessageHeader::try_from(data)?;
log::trace!("received header {header:?}");
if header.data_length() != 0 {
let mut msg_data = vec![0_u8; header.data_length() as usize];
let mut total_read = 0;
loop {
total_read +=
handle.read_bulk(endpoint.address, &mut msg_data[total_read..], timeout)?;
if total_read == msg_data.capacity() {
break;
}
let mut offset = 0;
while offset < msg_data.len() {
let end = (offset + max_packet_size).min(msg_data.len());
let chunk = &mut msg_data[offset..end];
offset += handle.read_bulk(endpoint.address, chunk, timeout)?;
}
let message = ADBTransportMessage::from_header_and_payload(header, msg_data);

View File

@@ -12,5 +12,7 @@ pub fn check_extension_is_apk<P: AsRef<Path>>(path: P) -> Result<()> {
}
}
log::debug!("Given file is an APK");
Ok(())
}

View File

@@ -21,10 +21,6 @@ name = "stub_gen"
[dependencies]
adb_client = { path = "../adb_client" }
anyhow = { version = "1.0.95" }
pyo3 = { version = "0.24.1", features = [
"abi3-py37",
"anyhow",
"extension-module",
] }
pyo3 = { version = "0.24.1", features = ["abi3-py37", "anyhow"] }
pyo3-stub-gen = "0.7.0"
pyo3-stub-gen-derive = "0.7.0"

View File

@@ -1,6 +1,16 @@
# pyadb_client
Python library to communicate with ADB devices. Built on top of Rust `adb_client` library.
<p align="center">
<p align="center">Python library to communicate with ADB devices. Built on top of Rust adb_client library.</p>
<p align="center">
<a href="https://pypi.org/project/pyadb_client">
<img alt="pypi.org" src="https://img.shields.io/pypi/v/pyadb_client.svg" />
</a>
<a href="https://pypi.org/project/pyadb_client">
<img alt="downloads" src="https://static.pepy.tech/badge/pyadb_client" />
</a>
</p>
</p>
## Installation