Users

Moin2GitUser

Represents a Moin user - for mapping to git user commits

Attributes:

Name	Type	Description
moin_id	str	MoinMoin user id - multi-component numeric string
moin_name	str	The Moin username - used as a git name
email	str	Email address of the user account

load_user_from_file(path, logger) classmethod

Reads the user data in from a moin user config file

Source code in moin2gitwiki/users.py

@classmethod
def load_user_from_file(cls, path, logger):
    """
    Reads the user data in from a moin user config file
    """
    with open(path) as f:
        data = f.read()
    moin_id = os.path.basename(path)
    user_dict = dict(re.findall(r"^([a-z_]+)=(.*)$", data, flags=re.MULTILINE))
    params = {"moin_id": moin_id, "moin_name": user_dict["name"]}
    if user_dict["email"] is not None and user_dict["email"] != "":
        params["email"] = re.sub("[^A-Za-z0-9@._-]", "", user_dict["email"])
    user = cls(**params)
    logger.debug(f"User added: {user.moin_name}")
    return user

Moin2GitUserSet

Represents a set of Moin users for mapping into git

Attributes:

Name	Type	Description
id_map	dict	maps moin user ids to Moin2GitUser objects
name_map	dict	maps moin user names to Moin2GitUser objects

create_from_users(users, logger) classmethod

Builds a Moin2GitUserSet from a list of Moin2GitUser objects

Source code in moin2gitwiki/users.py

@classmethod
def create_from_users(cls, users, logger):
    """
    Builds a Moin2GitUserSet from a list of Moin2GitUser objects
    """
    id_map = {}
    name_map = {}
    for user in users:
        id_map[user.moin_id] = user
        name_map[user.moin_name] = user
    # make sure we have an anonymous entry for things we cannot put a user to
    if "anonymous" not in name_map:
        anonymous = Moin2GitUser(
            moin_id="0000000000.00.00000",
            moin_name="anonymous",
            email="anonymous@example.org",
        )
        id_map[anonymous.moin_id] = anonymous
        name_map[anonymous.moin_name] = anonymous
    # package all the users into a set
    logger.debug("Building user set object")
    return cls(id_map=id_map, name_map=name_map)

get_user_by_id(self, ident)

Gets a Moin2GitUser by matching a moin id

Source code in moin2gitwiki/users.py

def get_user_by_id(self, ident):
    """
    Gets a Moin2GitUser by matching a moin id
    """
    return self.id_map[ident]

get_user_by_id_or_anonymous(self, ident)

Gets a Moin2GitUser by matching a moin id. If non-existant returns the anonymous id

Source code in moin2gitwiki/users.py

def get_user_by_id_or_anonymous(self, ident):
    """
    Gets a Moin2GitUser by matching a moin id.  If non-existant returns the anonymous id
    """
    if ident is None or ident not in self.id_map:
        return self.get_user_by_name("anonymous")
    else:
        return self.get_user_by_id(ident)

get_user_by_name(self, name)

Gets a Moin2GitUser by matching moin name

Source code in moin2gitwiki/users.py

def get_user_by_name(self, name):
    """
    Gets a Moin2GitUser by matching moin name
    """
    return self.name_map[name]

load_users_from_file(path, logger) classmethod

Builds a Moin2GitUserSet from a saved json file

Source code in moin2gitwiki/users.py

@classmethod
def load_users_from_file(cls, path, logger):
    """
    Builds a Moin2GitUserSet from a saved json file
    """
    logger.debug(f"Loading wiki users from {path}")
    with open(path) as f:
        user_data_set = json.loads(f.read())
    users = []
    for entry in user_data_set:
        user = Moin2GitUser(**entry)
        users.append(user)
        logger.debug(f"Loaded user name {user.moin_name}")
    return cls.create_from_users(users=users, logger=logger)

load_users_from_wiki_data(wiki_data_path, logger) classmethod

Builds a Moin2GitUserSet from the wiki filesystem

Source code in moin2gitwiki/users.py

@classmethod
def load_users_from_wiki_data(cls, wiki_data_path, logger):
    """
    Builds a Moin2GitUserSet from the wiki filesystem
    """
    users_dir = os.path.join(wiki_data_path, "user")
    logger.debug(f"Loading wiki users from {users_dir}")
    users = []
    for moin_id in os.listdir(users_dir):
        # check the moin id filename looks right
        if re.match(r"\d+\.\d+\.\d+$", moin_id):
            try:
                logger.debug(f"Loading user id {moin_id}")
                user = Moin2GitUser.load_user_from_file(
                    path=os.path.join(users_dir, moin_id),
                    logger=logger,
                )
                users.append(user)
            except OSError:
                continue
    return cls.create_from_users(users=users, logger=logger)

save_users_to_file(self, path)

Writes a Moin2GitUserSet to a saved json file

Source code in moin2gitwiki/users.py

def save_users_to_file(self, path):
    """
    Writes a Moin2GitUserSet to a saved json file
    """
    user_data = []
    for user in self.name_map.values():
        user_data.append(attr.asdict(user))
    with open(path, "w") as f:
        json.dump(user_data, f, indent=2, sort_keys=True)