1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*
 * This file is part of libloadorder
 *
 * Copyright (C) 2017 Oliver Hamlet
 *
 * libloadorder 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, or
 * (at your option) any later version.
 *
 * libloadorder is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libloadorder. If not, see <http://www.gnu.org/licenses/>.
 */

use std::error::Error;
use std::ptr;
use libc::{c_char, size_t, c_uint};
use loadorder::LoadOrderMethod;

use constants::*;
use helpers::{error, handle_error, to_c_string, to_c_string_array, to_str, to_str_vec};
use super::lo_game_handle;

/// Get which method is used for the load order.
///
/// The output is one of the `LIBLO_METHOD_*` constants.
///
/// Returns `LIBLO_OK` if successful, otherwise a `LIBLO_ERROR_*` code is returned.
#[no_mangle]
pub unsafe extern "C" fn lo_get_load_order_method(
    handle: lo_game_handle,
    method: *mut c_uint,
) -> c_uint {
    if handle.is_null() || method.is_null() {
        return error(LIBLO_ERROR_INVALID_ARGS, "Null pointer passed");
    }
    let handle = match (*handle).read() {
        Err(e) => return error(LIBLO_ERROR_POISONED_THREAD_LOCK, e.description()),
        Ok(h) => h,
    };

    *method = match handle.game_settings().load_order_method() {
        LoadOrderMethod::Timestamp => LIBLO_METHOD_TIMESTAMP,
        LoadOrderMethod::Textfile => LIBLO_METHOD_TEXTFILE,
        LoadOrderMethod::Asterisk => LIBLO_METHOD_ASTERISK,
    };

    LIBLO_OK
}

/// Get the current load order.
///
/// If no plugins are in the current order, the value pointed to by `plugins` will be null and
/// `num_plugins` will point to zero.
///
/// Returns `LIBLO_OK` if successful, otherwise a `LIBLO_ERROR_*` code is returned.
#[no_mangle]
pub unsafe extern "C" fn lo_get_load_order(
    handle: lo_game_handle,
    plugins: *mut *mut *mut c_char,
    num_plugins: *mut size_t,
) -> c_uint {
    if handle.is_null() || plugins.is_null() || num_plugins.is_null() {
        return error(LIBLO_ERROR_INVALID_ARGS, "Null pointer passed");
    }
    let handle = match (*handle).read() {
        Err(e) => return error(LIBLO_ERROR_POISONED_THREAD_LOCK, e.description()),
        Ok(h) => h,
    };

    *plugins = ptr::null_mut();
    *num_plugins = 0;

    let plugin_names = handle.plugin_names();

    if plugin_names.is_empty() {
        return LIBLO_OK;
    }

    match to_c_string_array(plugin_names) {
        Ok((pointer, size)) => {
            *plugins = pointer;
            *num_plugins = size;
        }
        Err(x) => return error(x, "A filename contained a null byte"),
    }

    LIBLO_OK
}


/// Set the load order.
///
/// Sets the load order to the passed plugin array, then scans the plugins directory and inserts
/// any plugins not included in the passed array.
///
/// Plugin files are inserted at the end of the load order, and master files are inserted after the
/// last master file in the load order. The order of plugin insertion is undefined besides the
/// distinction made between master files and plugin files.
///
/// Returns `LIBLO_OK` if successful, otherwise a `LIBLO_ERROR_*` code is returned.
#[no_mangle]
pub unsafe extern "C" fn lo_set_load_order(
    handle: lo_game_handle,
    plugins: *const *const c_char,
    num_plugins: size_t,
) -> c_uint {
    if handle.is_null() || plugins.is_null() {
        return error(LIBLO_ERROR_INVALID_ARGS, "Null pointer passed");
    }
    if num_plugins == 0 {
        return error(LIBLO_ERROR_INVALID_ARGS, "Zero-length plugin array passed.");
    }
    let mut handle = match (*handle).write() {
        Err(e) => return error(LIBLO_ERROR_POISONED_THREAD_LOCK, e.description()),
        Ok(h) => h,
    };

    let plugins: Vec<&str> = match to_str_vec(plugins, num_plugins) {
        Ok(x) => x,
        Err(x) => return error(x, "A filename contained a null byte"),
    };

    if let Err(x) = handle.set_load_order(&plugins) {
        return handle_error(x);
    }

    if let Err(x) = handle.save() {
        handle.plugins_mut().clear();
        return handle_error(x);
    }

    LIBLO_OK
}


/// Get the load order position of a plugin.
///
/// Load order positions are zero-based, so the first plugin in the load order has a position of
/// `0`, the next has a position of `1`, and so on.
///
/// Returns `LIBLO_OK` if successful, otherwise a `LIBLO_ERROR_*` code is returned.
#[no_mangle]
pub unsafe extern "C" fn lo_get_plugin_position(
    handle: lo_game_handle,
    plugin: *const c_char,
    index: *mut size_t,
) -> c_uint {
    if handle.is_null() || plugin.is_null() || index.is_null() {
        return error(LIBLO_ERROR_INVALID_ARGS, "Null pointer passed");
    }
    let handle = match (*handle).read() {
        Err(e) => return error(LIBLO_ERROR_POISONED_THREAD_LOCK, e.description()),
        Ok(h) => h,
    };

    let plugin = match to_str(plugin) {
        Ok(x) => x,
        Err(x) => return error(x, "The filename contained a null byte"),
    };

    match handle.index_of(plugin) {
        Some(x) => *index = x,
        None => return error(LIBLO_ERROR_FILE_NOT_FOUND, "Plugin not found"),
    }

    LIBLO_OK
}


/// Set the load order position of a plugin.
///
/// Sets the load order position of a plugin, removing it from its current position if it has one.
/// If the supplied position is greater than the last position in the load order, the plugin will
/// be positioned at the end of the load order. Load order positions are zero-based, so the first
/// plugin in the load order has a position of `0`, the next has a position of `1`, and so on.
///
/// Returns `LIBLO_OK` if successful, otherwise a `LIBLO_ERROR_*` code is returned.
#[no_mangle]
pub unsafe extern "C" fn lo_set_plugin_position(
    handle: lo_game_handle,
    plugin: *const c_char,
    index: size_t,
) -> c_uint {
    if handle.is_null() || plugin.is_null() {
        return error(LIBLO_ERROR_INVALID_ARGS, "Null pointer passed");
    }
    let mut handle = match (*handle).write() {
        Err(e) => return error(LIBLO_ERROR_POISONED_THREAD_LOCK, e.description()),
        Ok(h) => h,
    };

    let plugin = match to_str(plugin) {
        Ok(x) => x,
        Err(x) => return error(x, "The filename contained a null byte"),
    };

    if let Err(x) = handle.set_plugin_index(plugin, index) {
        return handle_error(x);
    }

    if let Err(x) = handle.save() {
        handle.plugins_mut().clear();
        return handle_error(x);
    }

    LIBLO_OK
}

/// Get filename of the plugin at a specific load order position.
///
/// Load order positions are zero-based, so the first plugin in the load order has a position of
/// `0`, the next has a position of `1`, and so on.
///
/// Returns `LIBLO_OK` if successful, otherwise a `LIBLO_ERROR_*` code is returned.
#[no_mangle]
pub unsafe extern "C" fn lo_get_indexed_plugin(
    handle: lo_game_handle,
    index: size_t,
    plugin: *mut *mut c_char,
) -> c_uint {
    if handle.is_null() || plugin.is_null() {
        return error(LIBLO_ERROR_INVALID_ARGS, "Null pointer passed");
    }
    let handle = match (*handle).read() {
        Err(e) => return error(LIBLO_ERROR_POISONED_THREAD_LOCK, e.description()),
        Ok(h) => h,
    };

    *plugin = ptr::null_mut();

    let plugin_name = match handle.plugin_at(index) {
        Some(x) => x,
        None => return error(LIBLO_ERROR_INVALID_ARGS, "Plugin is not in the load order"),
    };

    match to_c_string(&plugin_name) {
        Ok(x) => *plugin = x,
        Err(x) => return error(x, "The filename contained a null byte"),
    }

    LIBLO_OK
}