formatter.py

"""
格式化核心模块
解析 BibTeX，并根据选定样式（如 GB/T 7714）生成目标格式的引用字符串。
"""

import bibtexparser
from bibtexparser.bparser import BibTexParser
from bibtexparser.customization import convert_to_unicode


# 定义格式样式字典
FORMAT_STYLES = {
    "GBT2015": "GB/T 7714-2015 (期刊，3作者后加 et al.)",
    "GBT2005": "GB/T 7714-2005 (期刊，全作者或简写规则不同)",
    "APA": "APA 7th Edition",
    "IEEE": "IEEE Standard"
}


def format_bibtex_to_style(index, bibtex_string, target_style, key_info=None, confidence=None, warning=None):
    """
    将 BibTeX 字符串格式化为指定样式，并包含置信度信息。
    
    参数:
        index (int): 文献序号
        bibtex_string (str): BibTeX 格式字符串
        target_style (str): 目标格式样式代码（如 "GBT2015"）
        key_info (dict): 从输入中提取的关键信息，用于验证和修正卷期页
        confidence (float): 置信度评分 (0.0-1.0)，如果提供则显示在输出中
        warning (str): 缺项警告字符串，如果提供则显示在输出中
        
    返回:
        str: 格式化后的引用字符串，包含置信度信息
    """
    if not bibtex_string:
        return f"[{index}] 无法格式化：BibTeX 数据为空"
    
    try:
        # 解析 BibTeX
        parser = BibTexParser()
        parser.customization = convert_to_unicode
        bib_database = bibtexparser.loads(bibtex_string, parser=parser)
        
        if not bib_database.entries:
            return f"[{index}] 无法格式化：BibTeX 解析失败"
        
        entry = bib_database.entries[0]
        
        # 如果输入包含卷期页信息，进行验证和修正
        if key_info:
            # 检查并修正卷期页信息
            if key_info.get('volume') and not entry.get('volume'):
                entry['volume'] = key_info['volume']
                print(f"  ⚠ 使用输入中的卷号: {key_info['volume']}")
            elif key_info.get('volume') and entry.get('volume') != key_info['volume']:
                print(f"  ⚠ 卷号不匹配 - 检索: {entry.get('volume')}, 输入: {key_info['volume']}")
                # 使用输入中的卷号（更可靠）
                entry['volume'] = key_info['volume']
            
            if key_info.get('number') and not entry.get('number'):
                entry['number'] = key_info['number']
                print(f"  ⚠ 使用输入中的期号: {key_info['number']}")
            elif key_info.get('number') and entry.get('number') != key_info['number']:
                print(f"  ⚠ 期号不匹配 - 检索: {entry.get('number')}, 输入: {key_info['number']}")
                entry['number'] = key_info['number']
            
            if key_info.get('pages') and not entry.get('pages'):
                entry['pages'] = key_info['pages']
                print(f"  ⚠ 使用输入中的页码: {key_info['pages']}")
            elif key_info.get('pages') and entry.get('pages') != key_info['pages']:
                print(f"  ⚠ 页码不匹配 - 检索: {entry.get('pages')}, 输入: {key_info['pages']}")
                # 使用输入中的页码（更可靠）
                entry['pages'] = key_info['pages']
        
        # 根据样式格式化
        if target_style == "GBT2015":
            formatted_text = format_gbt2015(index, entry)
        elif target_style == "GBT2005":
            formatted_text = format_gbt2005(index, entry)
        elif target_style == "APA":
            formatted_text = format_apa(index, entry)
        elif target_style == "IEEE":
            formatted_text = format_ieee(index, entry)
        else:
            formatted_text = f"[{index}] 未知格式样式：{target_style}"
        
        # 添加置信度信息
        if confidence is not None and warning is not None:
            confidence_str = f"{confidence:.2f}"
            confidence_info = f" (置信度: {confidence_str}, {warning})"
            formatted_text += confidence_info
        
        return formatted_text
            
    except Exception as e:
        error_msg = f"[{index}] 格式化错误：{e}"
        if confidence is not None and warning is not None:
            error_msg += f" (置信度: {confidence:.2f}, {warning})"
        return error_msg


def format_gbt2015(index, entry):
    """
    格式化为 GB/T 7714-2015 标准。
    
    格式：作者. 题名[J]. 刊名, 年, 卷(期):页码.
    """
    # 提取作者
    authors = entry.get('author', '').split(' and ')
    author_str = format_authors_gbt(authors, max_authors=3)
    
    # 提取题名
    title = entry.get('title', '').strip('{}')
    
    # 文献类型标识
    entry_type = entry.get('ENTRYTYPE', 'article')
    type_marker = '[J]' if entry_type == 'article' else '[M]'
    
    # 提取刊名
    journal = entry.get('journal', entry.get('booktitle', '')).strip('{}')
    
    # 提取年份
    year = entry.get('year', '')
    
    # 提取卷
    volume = entry.get('volume', '')
    
    # 提取期
    number = entry.get('number', entry.get('issue', ''))
    
    # 提取页码
    pages = entry.get('pages', '').replace('--', '-')
    
    # 构建引用字符串
    # GB/T 7714-2015 格式：作者. 题名[J]. 刊名, 年, 卷(期):页码.
    # 题名和文献类型标识（题名和[J]之间没有点号）
    title_marker = ''
    if title:
        title_marker = f"{title}{type_marker}"  # 题名和[J]直接连接，无点号
    else:
        title_marker = type_marker
    
    # 构建前半部分：作者. 题名[J]. 刊名
    front_parts = []
    if author_str:
        front_parts.append(author_str)
    front_parts.append(title_marker)
    if journal:
        front_parts.append(journal)
    
    front_part = '. '.join(front_parts)
    
    # 构建后半部分：年, 卷(期):页码
    back_parts = []
    if year:
        back_parts.append(year)
    
    # 卷(期)部分
    volume_part = ''
    if volume:
        if number:
            volume_part = f"{volume}({number})"
        else:
            volume_part = volume
    elif number:
        volume_part = f"({number})"
    
    # 页码部分
    if pages:
        if volume_part:
            # 卷(期)后直接跟冒号和页码
            back_parts.append(f"{volume_part}:{pages}")
        else:
            # 只有页码，年份后直接跟冒号和页码
            back_parts.append(f":{pages}")
    elif volume_part:
        back_parts.append(volume_part)
    
    # 连接后半部分（用逗号分隔年份和卷(期)）
    if back_parts:
        back_part = ', '.join(back_parts)
        result = f"{front_part}, {back_part}."
    else:
        result = f"{front_part}."
    
    return f"[{index}] {result}"


def format_gbt2005(index, entry):
    """
    格式化为 GB/T 7714-2005 标准。
    与 2015 版本类似，但作者处理规则可能不同。
    """
    # 提取作者（2005版本可能显示更多作者）
    authors = entry.get('author', '').split(' and ')
    author_str = format_authors_gbt(authors, max_authors=5)  # 2005版本可能显示更多作者
    
    # 提取题名
    title = entry.get('title', '').strip('{}')
    
    # 文献类型标识
    entry_type = entry.get('ENTRYTYPE', 'article')
    type_marker = '[J]' if entry_type == 'article' else '[M]'
    
    # 提取刊名
    journal = entry.get('journal', entry.get('booktitle', '')).strip('{}')
    
    # 提取年份
    year = entry.get('year', '')
    
    # 提取卷
    volume = entry.get('volume', '')
    
    # 提取期
    number = entry.get('number', entry.get('issue', ''))
    
    # 提取页码
    pages = entry.get('pages', '').replace('--', '-')
    
    # 构建引用字符串
    # GB/T 7714-2005 格式：作者. 题名[J]. 刊名, 年, 卷(期):页码.
    result_parts = []
    
    # 作者部分
    if author_str:
        result_parts.append(author_str)
    
    # 题名和文献类型标识（题名和[J]之间没有点号）
    title_marker = ''
    if title:
        title_marker = f"{title}{type_marker}"  # 题名和[J]直接连接，无点号
    else:
        title_marker = type_marker
    
    # 构建前半部分：作者. 题名[J]. 刊名
    front_parts = []
    if author_str:
        front_parts.append(author_str)
    front_parts.append(title_marker)
    if journal:
        front_parts.append(journal)
    
    front_part = '. '.join(front_parts)
    
    # 构建后半部分：年, 卷(期):页码
    back_parts = []
    if year:
        back_parts.append(year)
    
    # 卷(期)部分
    volume_part = ''
    if volume:
        if number:
            volume_part = f"{volume}({number})"
        else:
            volume_part = volume
    elif number:
        volume_part = f"({number})"
    
    # 页码部分
    if pages:
        if volume_part:
            # 卷(期)后直接跟冒号和页码
            back_parts.append(f"{volume_part}:{pages}")
        else:
            # 只有页码，年份后直接跟冒号和页码
            back_parts.append(f":{pages}")
    elif volume_part:
        back_parts.append(volume_part)
    
    # 连接后半部分（用逗号分隔年份和卷(期)）
    if back_parts:
        back_part = ', '.join(back_parts)
        result = f"{front_part}, {back_part}."
    else:
        result = f"{front_part}."
    
    return f"[{index}] {result}"


def format_apa(index, entry):
    """
    格式化为 APA 7th Edition 标准。
    
    格式：Author, A. A., & Author, B. B. (Year). Title. Journal Name, Volume(Issue), Pages.
    """
    # 提取作者
    authors = entry.get('author', '').split(' and ')
    author_str = format_authors_apa(authors)
    
    # 提取年份
    year = entry.get('year', '')
    
    # 提取题名
    title = entry.get('title', '').strip('{}')
    
    # 提取刊名
    journal = entry.get('journal', entry.get('booktitle', '')).strip('{}')
    
    # 提取卷
    volume = entry.get('volume', '')
    
    # 提取期
    number = entry.get('number', entry.get('issue', ''))
    
    # 提取页码
    pages = entry.get('pages', '').replace('--', '-')
    
    # 构建引用字符串
    parts = []
    
    if author_str:
        parts.append(author_str)
    
    if year:
        parts.append(f"({year})")
    
    if title:
        parts.append(title)
    
    # 期刊信息
    journal_info = []
    if journal:
        journal_info.append(journal)
    
    if volume:
        if number:
            journal_info.append(f"{volume}({number})")
        else:
            journal_info.append(volume)
    elif number:
        journal_info.append(f"({number})")
    
    if journal_info:
        parts.append(', '.join(journal_info))
    
    if pages:
        parts.append(pages)
    
    result = '. '.join(parts)
    if not result.endswith('.'):
        result += '.'
    
    return f"[{index}] {result}"


def format_ieee(index, entry):
    """
    格式化为 IEEE 标准。
    
    格式：A. Author, B. Author, and C. Author, "Title," Journal Name, vol. X, no. Y, pp. Z, Year.
    """
    # 提取作者
    authors = entry.get('author', '').split(' and ')
    author_str = format_authors_ieee(authors)
    
    # 提取题名
    title = entry.get('title', '').strip('{}')
    
    # 提取刊名
    journal = entry.get('journal', entry.get('booktitle', '')).strip('{}')
    
    # 提取卷
    volume = entry.get('volume', '')
    
    # 提取期
    number = entry.get('number', entry.get('issue', ''))
    
    # 提取页码
    pages = entry.get('pages', '').replace('--', '-')
    
    # 提取年份
    year = entry.get('year', '')
    
    # 构建引用字符串
    parts = []
    
    if author_str:
        parts.append(author_str)
    
    if title:
        parts.append(f'"{title}"')
    
    if journal:
        parts.append(journal + ',')
    
    if volume:
        parts.append(f'vol. {volume}')
    
    if number:
        parts.append(f'no. {number}')
    
    if pages:
        parts.append(f'pp. {pages}')
    
    if year:
        parts.append(year)
    
    result = ', '.join(parts)
    if not result.endswith('.'):
        result += '.'
    
    return f"[{index}] {result}"


def format_authors_gbt(authors, max_authors=3):
    """
    格式化作者列表为 GB/T 格式。
    超过 max_authors 位作者时，只显示前 max_authors 位，然后加 et al.
    """
    if not authors:
        return ''
    
    # 清理作者名称
    cleaned_authors = []
    for author in authors:
        author = author.strip()
        if author:
            # 处理 "Family, Given" 格式
            if ',' in author:
                parts = author.split(',', 1)
                family = parts[0].strip()
                given = parts[1].strip() if len(parts) > 1 else ''
                # GB/T 格式：姓 名（名缩写，空格分隔，无点号）
                if given:
                    # 提取首字母，空格分隔，无点号
                    initials = ' '.join([n[0].upper() for n in given.split() if n])
                    cleaned_authors.append(f"{family} {initials}")
                else:
                    cleaned_authors.append(family)
            else:
                cleaned_authors.append(author)
    
    if not cleaned_authors:
        return ''
    
    # 如果作者数量超过限制，只显示前几位，然后加 et al.
    if len(cleaned_authors) > max_authors:
        displayed = cleaned_authors[:max_authors]
        return ', '.join(displayed) + ', et al'
    else:
        return ', '.join(cleaned_authors)


def format_authors_apa(authors):
    """
    格式化作者列表为 APA 格式。
    """
    if not authors:
        return ''
    
    formatted = []
    for i, author in enumerate(authors):
        author = author.strip()
        if not author:
            continue
        
        if ',' in author:
            # "Family, Given" 格式
            parts = author.split(',', 1)
            family = parts[0].strip()
            given = parts[1].strip() if len(parts) > 1 else ''
            if given:
                # 提取首字母
                initials = ' '.join([n[0].upper() + '.' for n in given.split() if n])
                formatted.append(f"{family}, {initials}")
            else:
                formatted.append(family)
        else:
            formatted.append(author)
    
    if not formatted:
        return ''
    
    if len(formatted) == 1:
        return formatted[0]
    elif len(formatted) == 2:
        return f"{formatted[0]} & {formatted[1]}"
    else:
        last = formatted[-1]
        others = ', '.join(formatted[:-1])
        return f"{others}, & {last}"


def format_authors_ieee(authors):
    """
    格式化作者列表为 IEEE 格式。
    """
    if not authors:
        return ''
    
    formatted = []
    for author in authors:
        author = author.strip()
        if not author:
            continue
        
        if ',' in author:
            # "Family, Given" 格式转换为 "G. Family" 格式
            parts = author.split(',', 1)
            family = parts[0].strip()
            given = parts[1].strip() if len(parts) > 1 else ''
            if given:
                # 提取首字母
                initials = '. '.join([n[0].upper() for n in given.split() if n])
                formatted.append(f"{initials}. {family}")
            else:
                formatted.append(family)
        else:
            formatted.append(author)
    
    if not formatted:
        return ''
    
    if len(formatted) == 1:
        return formatted[0]
    elif len(formatted) == 2:
        return f"{formatted[0]} and {formatted[1]}"
    else:
        last = formatted[-1]
        others = ', '.join(formatted[:-1])
        return f"{others}, and {last}"