xref: /developtools/hdc/hdc_rust/src/common/hdctransfer.rs (revision cc290419)

/*
 * Copyright (C) 2023 Huawei Device Co., Ltd.
 * 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, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
//! hdctransfer
#![allow(missing_docs)]
use std::collections::VecDeque;
use std::fs::{self, File, OpenOptions, metadata};
use std::io::{Read, Seek, Write, Error};
use std::path::PathBuf;
#[cfg(not(target_os = "windows"))]
use std::path::Path;
#[cfg(not(target_os = "windows"))]
use std::os::unix::fs::PermissionsExt;
use std::sync::Arc;

use crate::common::base::Base;
use crate::common::hdcfile::FileTaskMap;
use crate::config::HdcCommand;
use crate::config::TaskMessage;
use crate::{config::*, utils};
use crate::serializer::native_struct::TransferConfig;
use crate::serializer::native_struct::TransferPayload;
use crate::serializer::serialize::Serialization;
use crate::transfer;
#[cfg(not(feature = "host"))]
use crate::utils::hdc_log::*;
#[cfg(feature = "host")]
extern crate ylong_runtime_static as ylong_runtime;
use ylong_runtime::sync::Mutex;
use ylong_runtime::task::JoinHandle;

extern "C" {
    fn LZ4CompressTransfer(
        data: *const libc::c_char,
        dataCompress: *mut libc::c_char,
        data_size: i32,
        compressCapacity: i32,
    ) -> i32;
    fn LZ4DeompressTransfer(
        data: *const libc::c_char,
        dataDecompress: *mut libc::c_char,
        data_size: i32,
        decompressCapacity: i32,
    ) -> i32;
}

#[derive(Debug, Default, Clone, PartialEq, Eq)]
pub struct HdcTransferBase {
    pub need_close_notify: bool,
    pub io_index: u64,
    pub last_error: u32,
    pub is_io_finish: bool,
    pub is_master: bool,
    pub remote_path: String,
    pub base_local_path: String,
    pub local_path: String,
    pub server_or_daemon: bool,
    pub task_queue: Vec<String>,
    pub local_name: String,
    pub local_tar_raw_path: String,
    pub is_dir: bool,
    pub file_size: u64,
    pub dir_size: u64,
    pub session_id: u32,
    pub channel_id: u32,
    pub index: u64,
    pub file_cnt: u32,
    pub is_file_mode_sync: bool,
    pub file_begin_time: u64,
    pub dir_begin_time: u64,
    pub is_local_dir_exsit: Option<bool>,
    pub empty_dirs: String,
    pub stop_run: bool,
    pub command_str: String,

    pub transfer_config: TransferConfig,
}

impl HdcTransferBase {
    pub fn new(_session_id: u32, _channel_id: u32) -> Self {
        Self {
            need_close_notify: false,
            io_index: 0,
            last_error: 0,
            is_io_finish: false,
            is_master: false,
            remote_path: String::new(),
            base_local_path: String::new(),
            local_path: String::new(),
            local_tar_raw_path: String::new(),
            server_or_daemon: false,
            task_queue: Vec::<String>::new(),
            local_name: String::new(),
            is_dir: false,
            file_size: 0,
            dir_size: 0,
            session_id: _session_id,
            channel_id: _channel_id,
            index: 0,
            file_cnt: 0,
            is_file_mode_sync: false,
            file_begin_time: 0,
            dir_begin_time: 0,
            is_local_dir_exsit: None,
            empty_dirs: String::new(),
            stop_run: false,
            command_str: String::new(),
            transfer_config: TransferConfig::default(),
        }
    }
}

#[cfg(not(target_os = "windows"))]
fn set_file_permission(path: String, mode: u32) -> std::io::Result<()> {
    let perms = std::fs::Permissions::from_mode(mode);
    fs::set_permissions(std::path::Path::new(&path), perms)
}

#[cfg(not(target_os = "windows"))]
fn set_dir_permissions_recursive(dir: &Path, mode: u32) -> std::io::Result<()> {
    let perms = std::fs::Permissions::from_mode(mode);
    fs::set_permissions(dir, perms)?;

    for entry in fs::read_dir(dir)? {
        let entry = entry?;
        let entry_path = dir.join(entry.file_name());
        if entry_path.is_dir() {
            set_dir_permissions_recursive(&entry_path, mode)?;
        }
    }
    Ok(())
}

#[allow(unused)]
fn create_dir_all_with_permission(path: String, mode: u32) -> std::io::Result<()> {
    let mut dir_path = std::path::Path::new(&path);
    while let Some(p) = dir_path.parent() {
        if p.exists() {
            break;
        }
        dir_path = p;
    }
    #[cfg(not(target_os = "windows"))]
    let exsit = dir_path.exists();
    std::fs::create_dir_all(path.clone())?;
    #[cfg(not(target_os = "windows"))]
    if !exsit {
        set_dir_permissions_recursive(dir_path, mode)
    } else {
        Ok(())
    }
    #[cfg(target_os = "windows")]
    Ok(())
}

pub fn check_local_path(
    transfer: &mut HdcTransferBase,
    _local_path: &str,
    _optional_name: &str,
) -> Result<bool, Error> {
    crate::info!(
        "check_local_path, local_path:{}, optional_name:{}",
        _local_path,
        _optional_name
    );
    let file = metadata(_local_path);
    if let Ok(f) = file {
        if transfer.is_local_dir_exsit.is_none() {
            transfer.is_local_dir_exsit = Some(true);
        }
        transfer.is_dir = f.is_dir();
        if f.is_dir() && !transfer.local_path.ends_with(Base::get_path_sep()) {
            transfer
                .local_path
                .push_str(Base::get_path_sep().to_string().as_str());
        }
    } else if transfer.is_local_dir_exsit.is_none() {
        transfer.is_local_dir_exsit = Some(false);
    }
    let mut op = _optional_name.replace('\\', Base::get_path_sep().to_string().as_str());
    op = op.replace('/', Base::get_path_sep().to_string().as_str());

    if op.contains(Base::get_path_sep()) && !transfer.local_path.ends_with(Base::get_path_sep()) {
        transfer
            .local_path
            .push_str(Base::get_path_sep().to_string().as_str());
    }

    if transfer.local_path.ends_with(Base::get_path_sep()) {
        let local_dir = transfer
            .local_path
            .clone()
            .replace('/', Base::get_path_sep().to_string().as_str());

        if let Some(false) = transfer.is_local_dir_exsit {
            if op.contains(Base::get_path_sep()) {
                let first_sep_index = op.find(Base::get_path_sep()).unwrap_or_default();
                op = op.as_str()[first_sep_index..].to_string();
                crate::debug!(
                    "check_local_path, combine 2 local_dir:{}, op:{}",
                    local_dir,
                    op
                );
            }
        }

        transfer.local_path = Base::combine(local_dir, op);
    }
    crate::debug!(
        "check_local_path, final transfer.local_path:{}",
        transfer.local_path
    );
    if transfer.local_path.ends_with(Base::get_path_sep()) {
        match create_dir_all_with_permission(transfer.local_path.clone(), 0o750) {
            Ok(_) => Ok(true),
            Err(error) => {
                crate::error!("dir create failed, error:{}", &error);
                Err(error)
            },
        }
    } else {
        let last = transfer.local_path.rfind(Base::get_path_sep());
        match last {
            Some(index) => {
                match create_dir_all_with_permission((transfer.local_path[0..index]).to_string(), 0o750) {
                    Ok(_) => {
                        match File::create(transfer.local_path.clone()) {
                    Ok(_) => {
                        #[cfg(not(target_os = "windows"))]
                        set_file_permission(transfer.local_path.clone(), 0o644)?;
                        Ok(true)
                            },
                    Err(error) => {
                        crate::error!("file create failed, error:{}", &error);
                        Err(error)
                            },
                        }
                    }
                Err(error) => {
                    crate::error!("dir create failed, error:{}", &error);
                    Err(error)
                    },
                }
            }
            None => {
                match File::create(transfer.local_path.clone()) {
                Ok(_) => {
                    #[cfg(not(target_os = "windows"))]
                    set_file_permission(transfer.local_path.clone(), 0o644)?;
                    Ok(true)
                    },
                Err(error) => {
                    crate::error!("file create failed, error:{}", &error);
                    Err(error)
                    },
                }
            }
        }
    }
}

fn spawn_handler(
    _command_data: HdcCommand,
    index: usize,
    local_path: String,
    _channel_id_: u32,
    transfer_config: &TransferConfig,
) -> JoinHandle<(bool, TaskMessage)> {
    let thread_path_ref = Arc::new(Mutex::new(local_path));
    let pos = (index as u64) * (FILE_PACKAGE_PAYLOAD_SIZE as u64);
    let compress_type = transfer_config.compress_type;
    let file_size = transfer_config.file_size as u64;
    ylong_runtime::spawn(async move {
        let path = thread_path_ref.lock().await;
        let Ok(mut file) = File::open(&*path) else {
            crate::debug!("open file failed, path:{}", *path);
            let _data_message = TaskMessage {
                channel_id: _channel_id_,
                command: _command_data,
                payload: Vec::new(),
            };
            return (false, _data_message);
        };
        let _ = file.seek(std::io::SeekFrom::Start(pos));
        let mut total = Vec::from([0; FILE_PACKAGE_HEAD]);
        let mut buf: [u8; FILE_PACKAGE_PAYLOAD_SIZE] = [0; FILE_PACKAGE_PAYLOAD_SIZE];
        let mut data_buf: [u8; FILE_PACKAGE_PAYLOAD_SIZE] = [0; FILE_PACKAGE_PAYLOAD_SIZE];
        let mut read_len = 0usize;
        let mut package_read_len = (file_size - pos) as usize;
        if package_read_len > FILE_PACKAGE_PAYLOAD_SIZE {
            package_read_len = FILE_PACKAGE_PAYLOAD_SIZE;
        }
        while read_len < package_read_len {
            let Ok(single_len) = file.read(&mut buf[read_len..]) else {
                crate::debug!("file read failed, path:{}", *path);
                break;
            };
            read_len += single_len;
            if single_len == 0 && read_len < package_read_len {
                break;
            }
        }
        let transfer_compress_type = match CompressType::try_from(compress_type) {
            Ok(compress_type) => compress_type,
            Err(_) => CompressType::None,
        };

        let mut header: TransferPayload = TransferPayload {
            index: pos,
            compress_type,
            compress_size: 0,
            uncompress_size: 0,
        };
        header.uncompress_size = read_len as u32;
        let capacity = read_len as i32;

        match transfer_compress_type {
            CompressType::Lz4 => {
                let compress_size: i32;
                header.compress_type = CompressType::Lz4 as u8;
                unsafe {
                    compress_size = LZ4CompressTransfer(
                        buf.as_ptr() as *const libc::c_char,
                        data_buf.as_ptr() as *mut libc::c_char,
                        capacity,
                        capacity,
                    );
                }
                if compress_size > 0 {
                    header.compress_size = compress_size as u32;
                } else {
                    header.compress_type = CompressType::None as u8;
                    header.compress_size = read_len as u32;
                    data_buf = buf;
                }
            }
            _ => {
                header.compress_type = CompressType::None as u8;
                header.compress_size = read_len as u32;
                data_buf = buf;
            }
        }

        let head_buffer = header.serialize();
        total[..head_buffer.len()].copy_from_slice(&head_buffer[..]);
        let data_len = header.compress_size as usize;
        total.append(&mut data_buf[..data_len].to_vec());
        let _data_message = TaskMessage {
            channel_id: _channel_id_,
            command: _command_data,
            payload: total,
        };
        (read_len != FILE_PACKAGE_PAYLOAD_SIZE, _data_message)
    })
}

fn is_dir_link(path: String) -> bool {
    let ret = std::fs::read_link(path);
    match ret {
        Ok(p) => {
            crate::debug!("link to file:{}", p.display().to_string());
            p.exists() && p.is_dir()
        }
        Err(e) => {
            crate::error!("read_link fail:{:#?}", e);
            false
        }
    }
}

fn is_file_access(path: String) -> bool {
    let file = metadata(path.clone());
    match file {
        Ok(f) => {
            if !f.is_symlink() {
                crate::debug!("file is not a link, path:{}", path);
                return true;
            }
        }
        Err(_e) => {
            crate::error!("metadata file is error, path:{}", path);
            return false;
        }
    }
    let ret = std::fs::read_link(path);
    match ret {
        Ok(p) => {
            crate::debug!("link to file:{}", p.display().to_string());
            p.exists()
        }
        Err(e) => {
            crate::error!("read_link fail:{:#?}", e);
            false
        }
    }
}

pub async fn read_and_send_data(
    local_path: &str,
    session_id: u32,
    _channel_id_: u32,
    _file_size: u64,
    _command_data: HdcCommand,
    transfer_config: &TransferConfig,
) -> bool {
    const MAX_WORKER_COUNT: usize = 5;
    let mut pieces_count = (_file_size / FILE_PACKAGE_PAYLOAD_SIZE as u64) as usize;
    if pieces_count == 0 {
        pieces_count = 1;
    }
    let workers_count = if pieces_count > MAX_WORKER_COUNT {
        MAX_WORKER_COUNT
    } else {
        pieces_count
    };
    let mut index = 0;
    let mut queue = VecDeque::new();
    while index < workers_count {
        let worker = spawn_handler(
            _command_data,
            index,
            local_path.to_owned(),
            _channel_id_,
            transfer_config,
        );
        queue.push_back(worker);
        index += 1;
    }
    loop {
        if queue.is_empty() {
            crate::debug!("read_and_send_data queue is empty");
            break;
        }
        let Some(handler) = queue.pop_front() else {
            continue;
        };
        let Ok((is_finish, task_message)) = handler.await else {
            continue;
        };
        transfer::put(session_id, task_message).await;
        if is_finish {
            crate::debug!("read_and_send_data is finish return false");
            return false;
        }

        if (index as u64) * (FILE_PACKAGE_PAYLOAD_SIZE as u64) < _file_size {
            let worker = spawn_handler(
                _command_data,
                index,
                local_path.to_owned(),
                _channel_id_,
                transfer_config,
            );
            queue.push_back(worker);
            index += 1;
        }
    }
    true
}

pub fn recv_and_write_file(tbase: &mut HdcTransferBase, _data: &[u8]) -> bool {
    let mut header = TransferPayload {
        ..Default::default()
    };
    let _ = header.parse(_data[..FILE_PACKAGE_HEAD].to_vec());
    let file_index = header.index;
    let mut buffer = _data[FILE_PACKAGE_HEAD..].to_vec();
    let compress_type = match CompressType::try_from(tbase.transfer_config.compress_type) {
        Ok(compress_type) => compress_type,
        Err(_) => CompressType::None,
    };

    if let CompressType::Lz4 = compress_type {
        let buf: [u8; FILE_PACKAGE_PAYLOAD_SIZE] = [0; FILE_PACKAGE_PAYLOAD_SIZE];
        let decompress_size = unsafe {
            LZ4DeompressTransfer(
                _data[FILE_PACKAGE_HEAD..].as_ptr() as *const libc::c_char,
                buf.as_ptr() as *mut libc::c_char,
                header.compress_size as i32,
                header.uncompress_size as i32,
            )
        };
        if decompress_size > 0 {
            buffer = buf[..(decompress_size as usize)].to_vec();
        }
    }

    let path = tbase.local_path.clone();
    let write_buf = buffer.clone();
    let session_id = tbase.session_id.to_owned();
    let channel_id = tbase.channel_id.to_owned();
    utils::spawn(async move {
        let open_result = OpenOptions::new()
            .write(true)
            .create(true)
            .open(path.clone());
        match open_result {
            Ok(mut file) => {
                let _ = file.seek(std::io::SeekFrom::Start(file_index));
                let write_result = file.write_all(write_buf.as_slice());
                match write_result {
                    Ok(()) => {}
                    Err(e) => {
                        let _ = put_last_error(e, session_id, channel_id).await;
                    }
                }
            }
            Err(e) => {
                let _ = put_last_error(e, session_id, channel_id).await;
            }
        }
    });

    tbase.index += buffer.len() as u64;
    crate::debug!(
        "transfer file [{}] index {} / {}",
        tbase.local_path.clone(),
        tbase.index,
        tbase.file_size
    );
    if tbase.index >= tbase.file_size {
        return true;
    }
    false
}

async fn put_last_error(error: std::io::Error, session_id: u32, channel_id: u32) ->bool {
    crate::warn!(
        "put_last_error sesssion_id:{}, channel_id:{}, error:{}",
        session_id,
        channel_id,
        error,
    );
    let errno = match error.raw_os_error() {
        Some(errno) => errno as u32,
        None => std::i32::MAX as u32
    };
    match FileTaskMap::get(session_id, channel_id).await {
        Some(task) => {
            let mut task = task.lock().await;
            task.transfer.last_error = errno;
        }
        None => {
            crate::error!(
                "recv_and_write_file get task is none session_id:{},channel_id:{}",
                session_id,
                channel_id,
            );
            return false;
        }
    }
    true
}

pub fn get_sub_files_resurively(_path: &String) -> Vec<String> {
    let mut result = Vec::new();
    let dir_path = PathBuf::from(_path);
    if !is_file_access(_path.clone()) {
        crate::error!("file is invalid link, path:{}", _path);
        return result;
    }
    let Ok(dir_list) = fs::read_dir(dir_path) else {
        crate::error!("read dir fail, path:{}", _path);
        return result;
    };
    for entry in dir_list {
        let Ok(path) = entry else {
            continue;
        };
        let path = path.path();
        if is_dir_link(path.clone().display().to_string()) {
            continue;
        } else if path.is_file() {
            result.push(Base::normalized_path(path).display().to_string());
        } else {
            let p = path.display().to_string();
            let mut sub_list = get_sub_files_resurively(&p);
            result.append(&mut sub_list);
        }
    }
    result.sort();
    result
}

pub async fn transfer_begin(transfer: &HdcTransferBase, _command_data: HdcCommand) {
    let local_path_ = transfer.local_path.clone();

    read_and_send_data(
        &local_path_,
        transfer.session_id,
        transfer.channel_id,
        transfer.file_size,
        _command_data,
        &transfer.transfer_config,
    )
    .await;
}

pub fn transfer_data(tbase: &mut HdcTransferBase, _payload: &[u8]) -> bool {
    recv_and_write_file(tbase, _payload)
}

pub async fn transfer_task_finish(channel_id: u32, _session_id: u32) {
    let task_message = TaskMessage {
        channel_id,
        command: HdcCommand::KernelChannelClose,
        payload: [1].to_vec(),
    };
    transfer::put(_session_id, task_message).await;
}

pub async fn transfer_file_finish(channel_id: u32, _session_id: u32, comamnd_finish: HdcCommand) {
    let task_message = TaskMessage {
        channel_id,
        command: comamnd_finish,
        payload: [1].to_vec(),
    };
    transfer::put(_session_id, task_message).await;
}

pub async fn close_channel(channel_id: u32) {
    transfer::TcpMap::end(channel_id).await;
}

pub async fn echo_client(_session_id: u32, channel_id: u32, message: &str, level: MessageLevel) {
    #[cfg(feature = "host")]
    {
        let echo_level = match level {
            MessageLevel::Ok => transfer::EchoLevel::OK,
            MessageLevel::Fail => transfer::EchoLevel::FAIL,
            MessageLevel::Info => transfer::EchoLevel::INFO,
        };
        let _ =
            transfer::send_channel_msg(channel_id, echo_level, message.to_string())
                .await;
    }
    #[cfg(not(feature = "host"))]
    {
        let mut data = Vec::<u8>::new();
        data.push(level as u8);
        data.append(&mut message.as_bytes().to_vec());
        let echo_message = TaskMessage {
            channel_id,
            command: HdcCommand::KernelEcho,
            payload: data,
        };
        transfer::put(_session_id, echo_message).await;
    }
}