tiefdownlib 0.10.0

A library to manage and convert TiefDown projects.
Documentation
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
use crate::conversion_decider;
use crate::manifest_model::Injection;
use crate::manifest_model::Manifest;
use crate::manifest_model::MarkdownProject;
use crate::manifest_model::MetadataSettings;
use crate::manifest_model::Processors;
use crate::manifest_model::Template;
use crate::project_management::get_missing_dependencies;
use crate::project_management::load_and_convert_manifest;
use crate::project_management::run_smart_clean;
use chrono::prelude::DateTime;
use chrono::prelude::Utc;
use color_eyre::eyre::OptionExt;
use color_eyre::eyre::Result;
use color_eyre::eyre::eyre;
use fs_extra::dir;
use fs_extra::file;
use log::debug;
use log::error;
use log::info;
use log::warn;
use std::path::Path;
use std::path::PathBuf;
use toml::Table;

/// A task representing the conversion of a markdown project using a specific template.
/// Contains the markdown project and the template name.
pub struct ConversionTask {
    pub markdown_project: MarkdownProject,
    pub template: String,
}

/// Prepares the conversion queue based on the provided arguments.
///
/// # Arguments
///
/// * `project` - The path to the project directory (relative or absolute).
///   * Defaults to the current directory if not provided.
/// * `templates` - A list of template names to convert to.
///   * Defaults to all templates if not provided.
/// * `profile` - The name of the profile to use for conversion.
/// * `selected_markdown_projects` - A list of markdown project names to convert.
///   * Defaults to all markdown projects if not provided.
///
/// # Returns
///
/// A Result containing either an error or a vector of ConversionTask.
pub fn get_conversion_queue(
    project: Option<PathBuf>,
    templates: Option<Vec<String>>,
    profile: Option<String>,
    selected_markdown_projects: Option<Vec<String>>,
) -> Result<Vec<ConversionTask>> {
    if profile.is_some() && templates.is_some() {
        return Err(eyre!("Cannot specify both templates and a profile."));
    }

    let project = project.unwrap_or(PathBuf::from("."));

    if !project.exists() {
        return Err(eyre!("Project path does not exist."));
    }

    let manifest_path = project.join("manifest.toml");
    let manifest = load_and_convert_manifest(&manifest_path)?;

    let mut queue = vec![];

    let markdown_projects = manifest
        .markdown_projects
        .clone()
        .unwrap_or(vec![MarkdownProject {
            name: "Default".to_string(),
            path: PathBuf::from("Markdown"),
            output: PathBuf::from("."),
            metadata_fields: None,
            default_profile: None,
            resources: None,
        }]);

    let markdown_projects = if let Some(selected_markdown_projects) = selected_markdown_projects {
        markdown_projects
            .into_iter()
            .filter(|mp| selected_markdown_projects.contains(&mp.name))
            .collect()
    } else {
        markdown_projects
    };

    for markdown_project in markdown_projects {
        let profile = if let Some(profile) = profile.clone() {
            Some(profile)
        } else {
            markdown_project.clone().default_profile
        };

        let templates = get_template_names(&templates, &profile, &manifest)?;

        for template in templates {
            queue.push(ConversionTask {
                markdown_project: markdown_project.clone(),
                template,
            });
        }
    }

    Ok(queue)
}

/// Converts a TiefDown project to specified templates.
///
/// Runs the conversion process for all conversion tasks specified in the conversion queue.
///
/// # Arguments
///
/// * `project` - The path to the project directory (relative or absolute).
///   * Defaults to the current directory if not provided.
/// * `conversion_queue` - A vector of ConversionTask specifying which markdown projects to convert and which templates to use.
///   * Each ConversionTask contains a markdown project and a template name.
///   * A markdown project may be converted to multiple templates.
///   * A template may be used for multiple markdown projects.
///   * If empty, no conversion will be performed.
///
/// # Returns
///
/// A Result containing either an error or nothing.
pub fn convert(project: Option<PathBuf>, conversion_queue: Vec<ConversionTask>) -> Result<()> {
    let pandoc_errors = get_missing_dependencies(vec!["pandoc"])?;

    if !pandoc_errors.is_empty() {
        error!("{}", pandoc_errors.join("\n"));
        return Err(eyre!("Pandoc is not installed or not in the PATH."));
    }

    let other_dependencies = get_missing_dependencies(vec!["xelatex", "typst"])?;

    if !other_dependencies.is_empty() {
        warn!("{}", other_dependencies.join("\n"));
        warn!(
            "Some dependencies are missing. Some features may not work, and conversion may fail."
        );
    }

    let project = project.unwrap_or(PathBuf::from("."));

    if !project.exists() {
        return Err(eyre!("Project path does not exist."));
    }

    let manifest_path = project.join("manifest.toml");
    let manifest = load_and_convert_manifest(&manifest_path)?;

    if let Some(true) = manifest.smart_clean {
        let threshold = manifest.smart_clean_threshold.unwrap_or(5);
        run_smart_clean(&project, threshold.saturating_sub(1))?;
    }

    info!("Converting project: {}", project.to_string_lossy());

    let compiled_directory_path = create_build_directory(&project)?;

    debug!(
        "Converting in directory: {}",
        compiled_directory_path.display()
    );

    for conversion_task in conversion_queue {
        let markdown_project = conversion_task.markdown_project;
        let template = conversion_task.template;

        info!(
            "Converting markdown project '{}' with template '{}'.",
            markdown_project.name, template
        );

        let template = get_template_mapping_from_name(&template, &manifest)?;
        debug!("Resolved template mapping for {}.", template.name);
        let markdown_project_compiled_directory_path =
            compiled_directory_path.join(markdown_project.output.clone());

        dir::create_all(&markdown_project_compiled_directory_path, false)?;
        dir::copy(
            project.join("template/"),
            &markdown_project_compiled_directory_path,
            &dir::CopyOptions::new().overwrite(true).content_only(true),
        )?;

        debug!("Copied template directory.");

        let input_dir = project.join(markdown_project.path.clone());

        copy_resources(
            &markdown_project,
            &markdown_project_compiled_directory_path,
            &input_dir,
        )?;

        let shared_metadata = manifest.shared_metadata.clone().unwrap_or(Table::new());
        let project_metadata = markdown_project.metadata_fields.unwrap_or(Table::new());

        let merged_metadata = merge_metadata(&shared_metadata, &project_metadata);

        debug!(
            "Merged {} metadata fields ({} shared, {} project specific).",
            merged_metadata.len(),
            shared_metadata.len(),
            project_metadata.len()
        );

        let conversion_input_dir =
            &markdown_project_compiled_directory_path.join(template.name.clone() + "_convdir/");
        debug!(
            "Prepared conversion input directory: {}",
            conversion_input_dir.display()
        );

        copy_markdown_directory(
            &input_dir,
            &conversion_input_dir,
            &markdown_project.resources,
        )?;

        convert_template(
            &markdown_project_compiled_directory_path,
            &template,
            &project,
            &conversion_input_dir,
            &markdown_project.output,
            &merged_metadata,
            &manifest.metadata_settings,
            &manifest.custom_processors,
            &manifest.injections.clone().unwrap_or(vec![]),
        )?;
    }

    Ok(())
}

fn copy_resources(
    markdown_project: &MarkdownProject,
    markdown_project_compiled_directory_path: &PathBuf,
    markdown_dir: &PathBuf,
) -> Result<()> {
    for resource in markdown_project.resources.clone().unwrap_or(vec![]) {
        let resource = markdown_dir.join(resource.clone());

        if !resource.exists() {
            return Err(eyre!(
                "Resource file {} does not exist.",
                resource.display()
            ));
        }

        if resource.is_dir() {
            debug!("Copying directory: {}", resource.display());

            dir::copy(
                resource,
                markdown_project_compiled_directory_path,
                &dir::CopyOptions::new().overwrite(true).content_only(false),
            )?;
        } else {
            debug!("Copying file: {}", resource.display());

            file::copy(
                &resource,
                &markdown_project_compiled_directory_path
                    .join(resource.file_name().unwrap_or(std::ffi::OsStr::new("."))),
                &file::CopyOptions::new().overwrite(true),
            )?;
        }
    }

    Ok(())
}

fn merge_metadata(shared_metadata: &Table, project_metadata: &Table) -> Table {
    let mut merged_metadata = shared_metadata.clone();
    for (key, value) in project_metadata {
        merged_metadata.insert(key.clone(), value.clone());
    }
    merged_metadata
}

fn get_template_names(
    templates: &Option<Vec<String>>,
    profile: &Option<String>,
    manifest: &Manifest,
) -> Result<Vec<String>> {
    if let Some(templates) = templates {
        debug!(
            "get_template_names: using provided templates ({}).",
            templates.len()
        );
        return Ok(templates.clone());
    }

    if let Some(profile) = profile {
        if let Some(available_profiles) = &manifest.profiles {
            if let Some(profile_pos) = available_profiles.iter().position(|p| p.name == *profile) {
                let resolved: Vec<String> = available_profiles[profile_pos]
                    .templates
                    .iter()
                    .map(|t| t.clone())
                    .collect();
                debug!(
                    "get_template_names: using profile '{}' with {} templates.",
                    profile,
                    resolved.len()
                );
                return Ok(resolved);
            } else {
                return Err(eyre!("Profile '{}' could not be found.", profile));
            }
        } else {
            return Err(eyre!("No profiles are defined in the manifest.toml file."));
        }
    }
    let all: Vec<String> = manifest.templates.iter().map(|t| t.name.clone()).collect();
    debug!(
        "get_template_names: no explicit selection; using all templates ({}).",
        all.len()
    );
    Ok(all)
}

fn get_template_mapping_from_name(template: &String, manifest: &Manifest) -> Result<Template> {
    let template = manifest
        .templates
        .iter()
        .find(|mapping| mapping.name == *template)
        .ok_or_eyre(eyre!(
            "Template '{}' could not be found in the manifest.",
            template
        ))?;

    Ok(template.clone())
}

fn create_build_directory(project_path: &Path) -> Result<std::path::PathBuf> {
    let current_time = std::time::SystemTime::now();
    let current_time: DateTime<Utc> = current_time.into();
    let current_time = current_time.format("%Y-%m-%d_%H-%M-%S").to_string();
    let build_directory_path = project_path.join(current_time);

    dir::create_all(&build_directory_path, false)?;

    debug!(
        "Created build directory at '{}'.",
        build_directory_path.display()
    );
    Ok(build_directory_path)
}

fn copy_markdown_directory(
    markdown_dir: &Path,
    output_dir: &Path,
    resources: &Option<Vec<PathBuf>>,
) -> Result<()> {
    debug!(
        "Copying markdown directory '{}' to '{}'",
        markdown_dir.display(),
        output_dir.display()
    );

    if !output_dir.exists() {
        dir::create_all(output_dir, false)?;
    }

    dir::copy(
        markdown_dir,
        output_dir,
        &dir::CopyOptions::new().overwrite(true).content_only(true),
    )?;

    for resource in resources.clone().unwrap_or(vec![]) {
        let resource = output_dir.join(resource.clone());

        if resource.is_dir() {
            dir::remove(resource)?;
        } else {
            file::remove(resource)?;
        }
    }

    Ok(())
}

fn convert_template(
    compiled_directory_path: &Path,
    template: &Template,
    project_path: &Path,
    conversion_input_dir: &Path,
    output_dir: &Path,
    metadata_fields: &Table,
    metadata_settings: &Option<MetadataSettings>,
    custom_processors: &Processors,
    injections: &Vec<Injection>,
) -> Result<()> {
    debug!("Starting template conversion for '{}'.", template.name);
    debug!("  Template type: '{}'.", template.template_type);

    let converter = conversion_decider::get_converter(&template.template_type)?;

    let metadata_settings = metadata_settings
        .clone()
        .unwrap_or(MetadataSettings::default());

    debug!("Running converter...");

    let result_file_path = converter(
        project_path,
        compiled_directory_path,
        conversion_input_dir,
        template,
        metadata_fields,
        &metadata_settings,
        custom_processors,
        injections,
    )?;

    debug!("Converter finished.");
    debug!("  Result file path: {}", result_file_path.display());

    debug!("Copying result file to output directory...");

    dir::create_all(project_path.join(output_dir), false)?;
    file::copy(
        &result_file_path,
        project_path
            .join(output_dir)
            .join(result_file_path.file_name().unwrap_or_default()),
        &file::CopyOptions::new().overwrite(true),
    )?;

    debug!("Copying finished.");

    info!("Conversion successful.");
    Ok(())
}