Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
"""Utility functions for vikingbot."""
from datetime import datetime
from pathlib import Path
from loguru import logger
def ensure_dir(path: Path) -> Path:
"""Ensure a directory exists, creating it if necessary."""
if not path.exists():
logger.info(f"Creating directory: {path}")
path.mkdir(parents=True, exist_ok=True)
return path
# Global bot data path - must be set before use
_bot_data_path: Path | None = None
def set_bot_data_path(path: Path) -> None:
"""Set the global bot data path."""
global _bot_data_path
expanded_path = path.expanduser()
if not expanded_path.exists():
logger.info(f"Storage workspace directory does not exist, will be created: {expanded_path}")
_bot_data_path = expanded_path
def get_bot_data_path() -> Path:
"""Get the bot data directory. set_bot_data_path() must be called first."""
global _bot_data_path
if not _bot_data_path:
raise RuntimeError("bot_data_path not set. Call set_bot_data_path() first.")
return ensure_dir(_bot_data_path)
def get_data_path() -> Path:
"""Get the bot data directory. Alias for get_bot_data_path()."""
return get_bot_data_path()
def get_sessions_path() -> Path:
"""Get the sessions storage directory."""
return ensure_dir(get_bot_data_path() / "sessions")
def get_history_path() -> Path:
"""Get the CLI history directory."""
return ensure_dir(get_bot_data_path() / "history")
# Moonshot and similar APIs reject assistant turns with empty or whitespace-only content
# (common on tool-only model replies where `content` is null or "").
_ASSISTANT_NON_EMPTY_PLACEHOLDER = " "
def ensure_non_empty_assistant_content(content: str | None) -> str:
"""
Normalize text for an OpenAI-style `assistant` message `content` field.
Some providers return 400 if content is missing, null, or empty after stripping.
"""
if content is None or (isinstance(content, str) and not content.strip()):
return _ASSISTANT_NON_EMPTY_PLACEHOLDER
return content
def get_bridge_path() -> Path:
"""Get the bridge directory."""
return ensure_dir(get_bot_data_path() / "bridge")
def get_images_path() -> Path:
"""Get the images directory."""
return ensure_dir(get_bot_data_path() / "images")
def get_media_path() -> Path:
"""Get the media directory."""
return ensure_dir(get_bot_data_path() / "media")
def get_received_path() -> Path:
"""Get the received files directory."""
return ensure_dir(get_bot_data_path() / "received")
def get_mochat_path() -> Path:
"""Get the mochat state directory."""
return ensure_dir(get_bot_data_path() / "mochat")
def get_mounts_path() -> Path:
"""Get the mounts directory."""
return ensure_dir(get_bot_data_path() / "mounts")
def get_source_workspace_path() -> Path:
"""Get the source workspace path from the codebase."""
package_workspace = Path(__file__).parent.parent / "workspace"
if package_workspace.is_dir():
return package_workspace
return Path(__file__).parent.parent.parent / "workspace"
def get_workspace_path() -> Path:
return ensure_dir(get_bot_data_path() / "workspace")
def ensure_workspace_templates(workspace: Path) -> None:
import shutil
from vikingbot.agent.skills import BUILTIN_SKILLS_DIR
# Ensure workspace directory exists first
ensure_dir(workspace)
# Check if workspace has any of the bootstrap files
bootstrap_files = ["AGENTS.md", "SOUL.md", "USER.md", "TOOLS.md", "IDENTITY.md"]
has_any_file = any((workspace / filename).exists() for filename in bootstrap_files)
if not has_any_file:
# Workspace is empty, copy templates from source
source_dir = get_source_workspace_path()
if not source_dir.exists():
# Fallback: create minimal templates
_create_minimal_workspace_templates(workspace)
else:
# Copy all files and directories from source workspace
for item in source_dir.iterdir():
src = source_dir / item.name
dst = workspace / item.name
if src.is_dir():
if src.name == "memory":
# Ensure memory directory exists
dst.mkdir(exist_ok=True)
# Copy memory files
for mem_file in src.iterdir():
if mem_file.is_file():
shutil.copy2(mem_file, dst / mem_file.name)
else:
# Copy other directories
shutil.copytree(src, dst, dirs_exist_ok=True)
else:
# Copy individual files
if not dst.exists():
shutil.copy2(src, dst)
# Ensure skills directory exists (for custom user skills)
skills_dir = workspace / "skills"
skills_dir.mkdir(exist_ok=True)
# Copy built-in skills to workspace skills directory
if BUILTIN_SKILLS_DIR.exists() and BUILTIN_SKILLS_DIR.is_dir():
for skill_dir in BUILTIN_SKILLS_DIR.iterdir():
if skill_dir.is_dir() and skill_dir.name != "README.md":
dst_skill_dir = skills_dir / skill_dir.name
if not dst_skill_dir.exists():
shutil.copytree(skill_dir, dst_skill_dir)
# Always ensure memory and skills directories exist
memory_dir = workspace / "memory"
memory_dir.mkdir(exist_ok=True)
# Create default memory files if they don't exist
memory_file = memory_dir / "MEMORY.md"
if not memory_file.exists():
memory_file.write_text("""# Long-term Memory
This file stores important information that should persist across sessions.
## User Information
(Important facts about the user)
## Preferences
(User preferences learned over time)
## Important Notes
(Things to remember)
""")
history_file = memory_dir / "HISTORY.md"
if not history_file.exists():
history_file.write_text("")
skills_dir = workspace / "skills"
skills_dir.mkdir(exist_ok=True)
def ensure_session_workspace(workspace_path: Path) -> Path:
if workspace_path.exists() and workspace_path.is_dir():
return workspace_path
ensure_workspace_templates(workspace_path)
return workspace_path
def _create_minimal_workspace_templates(workspace: Path) -> None:
"""Create minimal workspace templates as fallback."""
templates = {
"AGENTS.md": """# Agent Instructions
You are a helpful AI assistant. Be concise, accurate, and friendly.
## Guidelines
- Always explain what you're doing before taking actions
- Ask for clarification when the request is ambiguous
- Use tools to help accomplish tasks
- Remember important information in openviking, and memory/MEMORY.md; past events are logged in openviking, and memory/HISTORY.md
""",
"SOUL.md": """# Soul
I am vikingbot, a lightweight AI assistant.
## Personality
- Helpful and friendly
- Concise and to the point
- Curious and eager to learn
## Values
- Accuracy over speed
- User privacy and safety
- Transparency in actions
""",
"USER.md": """# User
Information about the user goes here.
## Preferences
- Communication style: (casual/formal)
- Timezone: (your timezone)
- Language: (your preferred language)
""",
}
for filename, content in templates.items():
file_path = workspace / filename
if not file_path.exists():
file_path.write_text(content)
# Create memory directory and MEMORY.md
memory_dir = workspace / "memory"
memory_dir.mkdir(exist_ok=True)
memory_file = memory_dir / "MEMORY.md"
if not memory_file.exists():
memory_file.write_text("""# Long-term Memory
This file stores important information that should persist across sessions.
## User Information
(Important facts about the user)
## Preferences
(User preferences learned over time)
## Important Notes
(Things to remember)
""")
history_file = memory_dir / "HISTORY.md"
if not history_file.exists():
history_file.write_text("")
# Create skills directory for custom user skills
skills_dir = workspace / "skills"
skills_dir.mkdir(exist_ok=True)
def get_skills_path(workspace: Path | None = None) -> Path:
"""Get the skills directory within the workspace."""
ws = workspace or get_workspace_path()
return ensure_dir(ws / "skills")
def cal_str_tokens(text: str, text_type: str = "mixed") -> int:
char_length = len(text)
if text_type == "en":
token_count = char_length / 4.5 # 1 token ≈ 4.5个英文字符
elif text_type == "zh":
token_count = char_length / 1.1 # 1 token ≈ 1.1个中文字符
else: # mixed
token_count = char_length / 2.5 # 混合文本折中值
return int(token_count) + 1
def timestamp() -> str:
"""Get current timestamp in ISO format."""
return datetime.now().isoformat()
def truncate_string(s: str, max_len: int = 100, suffix: str = "...") -> str:
"""Truncate a string to max length, adding suffix if truncated."""
if len(s) <= max_len:
return s
return s[: max_len - len(suffix)] + suffix