parser.cc

#include <iostream>
#include <string>
#include <vector>
#include <boost/filesystem.hpp>
#include "util.hpp"

const std::string src_path = "data/input";
const std::string output = "data/raw_html/raw.txt";

typedef struct DocInfo
{
    std::string title;   // 文档标题
    std::string content; // 文档内容
    std::string url;     // 改文档在官网中的url
} DocInfo_t;

// const &: 输入
//*： 输出
//&： 输入输出
bool EnumFile(const std::string &src_path, std::vector<std::string> *files_list);
bool ParseHtml(const std::vector<std::string> &file_list, std::vector<DocInfo_t> *results);
bool SaveHtml(const std::vector<DocInfo_t> &results, const std::string &output);

int main()
{
    std::vector<std::string> files_list;
    // 第一步: 递归式的把每个html文件名带路径，保存到files_list中，方便后期进行一个一个的文件进行读取
    if (!EnumFile(src_path, &files_list))
    {
        std::cerr << "enum file name error!" << std::endl;
        return 1;
    }

    // 第二步: 按照files_list读取每个文件的内容，并进行解析
    std::vector<DocInfo_t> results;
    if (!ParseHtml(files_list, &results))
    {
        std::cerr << "parse html error" << std::endl;
        return 2;
    }

    // 第三步: 把解析完毕的各个文件内容，写入到output,按照\3作为每个文档的分割符
    if (!SaveHtml(results, output))
    {
        std::cerr << "save html error" << std::endl;
        return 3;
    }
    return 0;
}

// 遍历目录，获取所有.html文件的完整路径
bool EnumFile(const std::string &src_path, std::vector<std::string> *files_list)
{
    namespace fs = boost::filesystem;
    fs::path root_path(src_path);
    // 判断路径是否存在
    if (!fs::exists(root_path))
    {
        std::cerr << src_path << "not exists" << std::endl;
        return false;
    }

    // 定义一个空迭代器，用来进行判断递归结束
    fs::recursive_directory_iterator end;
    for (fs::recursive_directory_iterator iter(root_path); iter != end; iter++)
    {
        // 判断文件是否为普通文件，html都是普通文件
        if (!fs ::is_regular_file(*iter))
        {
            continue;
        }
        if (iter->path().extension() != ".html")
        {
            continue;
        }
        // 当前的路径是一个合法路径，以.html结束的普通网页文件
        files_list->push_back(iter->path().string());
    }
    return true;
}

// 从html内容中截取<title>标签内的文本
static bool ParseTitle(const std::string &file, std::string *title)
{
    std::size_t begin = file.find("<title>");
    if (begin == std::string::npos)
        return false;
    std::size_t end = file.find("</title>");
    if (end == std::string::npos)
        return false;
    begin += std::string("<title>").size(); // 定位到标题内容的真实起点
    if (begin > end)
        return false;
    *title = file.substr(begin, end - begin); // 截取并赋值
    return true;
}

// 剔除HTML标签，仅保留纯文本内容
static bool ParseContent(const std::string &file, std::string *content)
{
    // 去标签，基于一个状态机
    enum status
    {
        LABLE,
        CONTENT
    };
    enum status s = LABLE; // 初始状态在标签内
    for (char c : file)
    {
        switch (s)
        {
        case LABLE:
            if (c == '>')
                s = CONTENT; // 遇到 '>' 表示标签结束，进入内容区
            break;
        case CONTENT:
            if (c == '<')
                s = LABLE; // 遇到 '<' 表示内容结束，进入标签区
            else
            {
                // 我们不想保留原始文件中的\n,因为我们想用\n作为html解析之后文本的分隔符
                // 同时处理 \r（Windows 换行符的 CR 部分）和其他空白字符
                if (c == '\n' || c == '\r')
                    c = ' ';
                // 避免连续空格堆积
                if (c == ' ' && !content->empty() && content->back() == ' ')
                    continue;
                content->push_back(c);
            }
            break;
        default:
            break;
        }
    }
    return true;
}

// 根据本地文件路径，拼接出对应的 Boost 官方在线文档 URL
static bool ParseUrl(const std::string &file_path, std::string *url)
{
    std::string url_head = "https://www.boost.org/doc/libs/1_82_0/doc/html";
    std::string url_tail = file_path.substr(src_path.size());
    *url = url_head + url_tail;
    return true;
}

// for debug
//  打印单篇文档的解析结果，用于调试
static void ShowDoc(const DocInfo_t &doc)
{
    std::cout << "title: " << doc.title << std::endl;
    std::cout << "content: " << doc.content << std::endl;
    std::cout << "url: " << doc.url << std::endl;
}

// 核心解析调度函数：循环处理所有找到的 HTML 文件
bool ParseHtml(const std::vector<std::string> &files_list, std::vector<DocInfo_t> *results)
{
    for (const std::string &file : files_list)
    {
        // 1.读取文件
        std::string result;
        if (!ns_util::FileUtil::ReadFile(file, &result))
            continue;
        DocInfo_t doc;
        // 2.解析指定文件 ，提取title
        if (!ParseTitle(result, &doc.title))
            continue;
        // 3.解析指定文件 ，提取content,就是去标签
        if (!ParseContent(result, &doc.content))
            continue;
        // 4. 解析指定的文件路径，构建url
        if (!ParseUrl(file, &doc.url))
        {
            continue;
        }
        results->push_back(std::move(doc));
    }
    return true;
}

//// 将清洗和解析后的结构化数据，格式化写入到统一的纯文本文件中
bool SaveHtml(const std::vector<DocInfo_t>&results,const std::string &output)
{
   #define SEP '\3' // 使用不可见字符 \3 作为 title、content、url 之间的分隔符
    //按照二进制方式进行写入
    std::ofstream out(output,std::ios::out | std::ios::binary);
    if(!out.is_open())
    {
        std::cerr << "open " << output << " failed!" << std::endl;
        return false;
    } 
    //进行文件内容的写入了
    for(auto &item:results)
    {
        std::string  out_string;
        // 拼装单行数据：title \3 content \3 url \n
        out_string+=item.title;
        out_string += SEP;
        out_string += item.content;
        out_string += SEP;
        out_string += item.url;
        out_string += '\n'; // 换行符区分不同的文档
        out.write(out_string.c_str(),out_string.size());
    }
     out.close(); // 关闭文件流
     return true;
}