core_service/src/stub.rs

/*
 * Copyright (c) 2023-2024 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.
 */

//! This module implements the stub of the Asset service.

use asset_common::{AutoCounter, CallingInfo, OwnerType, ProcessInfo, ProcessInfoDetail};
use ipc::{parcel::MsgParcel, remote::RemoteStub, IpcResult, IpcStatusCode};

use asset_definition::{AssetError, Result};
use asset_ipc::{deserialize_map, serialize_maps, IpcCode, IPC_SUCCESS, SA_NAME};
use asset_log::{loge, logi};
use asset_plugin::asset_plugin::AssetPlugin;
use asset_sdk::{
    log_throw_error,
    plugin_interface::{
        EventType, ExtDbMap, PARAM_NAME_APP_INDEX, PARAM_NAME_BUNDLE_NAME, PARAM_NAME_IS_HAP, PARAM_NAME_USER_ID,
    },
    ErrCode, Tag, Value,
};

use crate::{unload_handler::DELAYED_UNLOAD_TIME_IN_SEC, unload_sa, AssetService};

const REDIRECT_START_CODE: u32 = 200;

impl RemoteStub for AssetService {
    fn on_remote_request(
        &self,
        code: u32,
        data: &mut ipc::parcel::MsgParcel,
        reply: &mut ipc::parcel::MsgParcel,
    ) -> i32 {
        let _counter_user = AutoCounter::new();
        self.system_ability.cancel_idle();
        unload_sa(DELAYED_UNLOAD_TIME_IN_SEC as u64);

        if code >= REDIRECT_START_CODE {
            return on_extension_request(self, code, data, reply);
        }

        match on_remote_request(self, code, data, reply) {
            Ok(_) => IPC_SUCCESS as i32,
            Err(e) => e as i32,
        }
    }

    fn descriptor(&self) -> &'static str {
        SA_NAME
    }
}

fn on_app_request(process_info: &ProcessInfo, calling_info: &CallingInfo) -> Result<()> {
    let app_index = match &process_info.process_info_detail {
        ProcessInfoDetail::Hap(hap_info) => hap_info.app_index,
        ProcessInfoDetail::Native(_) => 0,
    };
    let mut params = ExtDbMap::new();

    // to get the real user id to operate Asset
    params.insert(PARAM_NAME_USER_ID, Value::Number(calling_info.user_id() as u32));
    params.insert(PARAM_NAME_BUNDLE_NAME, Value::Bytes(process_info.process_name.clone()));
    params.insert(PARAM_NAME_IS_HAP, Value::Bool(process_info.owner_type == OwnerType::Hap));
    params.insert(PARAM_NAME_APP_INDEX, Value::Number(app_index as u32));

    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        match load.process_event(EventType::OnAppCall, &params) {
            Ok(()) => return Ok(()),
            Err(code) => {
                return log_throw_error!(ErrCode::BmsError, "[FATAL]process on app call event failed, code: {}", code)
            },
        }
    }
    Ok(())
}

fn on_remote_request(stub: &AssetService, code: u32, data: &mut MsgParcel, reply: &mut MsgParcel) -> IpcResult<()> {
    match data.read_interface_token() {
        Ok(interface_token) if interface_token == stub.descriptor() => {},
        _ => {
            loge!("[FATAL][SA]Invalid interface token.");
            return Err(IpcStatusCode::Failed);
        },
    }
    let ipc_code = IpcCode::try_from(code).map_err(asset_err_handle)?;

    let map = deserialize_map(data).map_err(asset_err_handle)?;

    let process_info = ProcessInfo::build().map_err(asset_err_handle)?;
    let calling_info = CallingInfo::build(map.get(&Tag::UserId).cloned(), &process_info);
    on_app_request(&process_info, &calling_info).map_err(asset_err_handle)?;

    match ipc_code {
        IpcCode::Add => reply_handle(stub.add(&calling_info, &map), reply),
        IpcCode::Remove => reply_handle(stub.remove(&calling_info, &map), reply),
        IpcCode::Update => {
            let update_map = deserialize_map(data).map_err(asset_err_handle)?;
            reply_handle(stub.update(&calling_info, &map, &update_map), reply)
        },
        IpcCode::PreQuery => match stub.pre_query(&calling_info, &map) {
            Ok(res) => {
                reply_handle(Ok(()), reply)?;
                reply.write::<Vec<u8>>(&res)
            },
            Err(e) => reply_handle(Err(e), reply),
        },
        IpcCode::Query => match stub.query(&calling_info, &map) {
            Ok(res) => {
                reply_handle(Ok(()), reply)?;
                serialize_maps(&res, reply).map_err(asset_err_handle)
            },
            Err(e) => reply_handle(Err(e), reply),
        },
        IpcCode::PostQuery => reply_handle(stub.post_query(&calling_info, &map), reply),
    }
}

fn on_extension_request(_stub: &AssetService, code: u32, data: &mut MsgParcel, reply: &mut MsgParcel) -> i32 {
    if let Ok(load) = AssetPlugin::get_instance().load_plugin() {
        match load.redirect_request(code, data, reply) {
            Ok(()) => {
                logi!("process redirect request success.");
                return IPC_SUCCESS as i32;
            },
            Err(code) => {
                loge!("process redirect request failed, code: {}", code);
                return code as i32;
            },
        }
    }
    IpcStatusCode::Failed as i32
}

fn asset_err_handle(e: AssetError) -> IpcStatusCode {
    loge!("[IPC]Asset error code = {}, msg is {}", e.code, e.msg);
    IpcStatusCode::InvalidValue
}

fn reply_handle(ret: Result<()>, reply: &mut MsgParcel) -> IpcResult<()> {
    match ret {
        Ok(_) => reply.write::<u32>(&IPC_SUCCESS),
        Err(e) => {
            reply.write::<u32>(&(e.code as u32))?;
            reply.write::<String>(&e.msg)
        },
    }
}