Skip to content

moin2gitwiki

Git Revision

Git Revision

`GitExportStream`

Output a git fast-export formatted stream for each revision

This object handles the state information to output the git commits for the Moin wiki revisions.

Attributes:

Name	Type	Description
`output`	`BinaryIO`	The output file stream of git fast-export commands
`mark_number`	`int`	The current git mark number
`last_commit_mark`	`int`	The git mark number of the last commit
`ctx`		The context object - used for `logger` and `user` mapping

`add_wiki_revision(self, revision, content)`

Add a wiki revision as a git commit

Parameters:

Name	Type	Description	Default
`revision`	`MoinEditEntry`	A wiki revision object	required
`content`	`bytes`	The content of the wiki object, after translation, as bytes	required

Source code in moin2gitwiki/gitrevision.py

def add_wiki_revision(
    self,
    revision: MoinEditEntry,
    content: bytes,
):
    """
    Add a wiki revision as a git commit

    Parameters:
        revision:   A wiki revision object
        content:    The content of the wiki object, after translation, as bytes

    """
    name = revision.markdown_page_path()
    if content is not None:
        blob_ref = self.output_blob(content)
    elif revision.edit_type == MoinEditType.ATTACH:
        blob_ref = self.output_blob(revision.attachment_content_bytes())
    if self.last_commit_mark is None:
        self.write_string(f"reset {self.branch}\n")
    self.write_string(f"commit {self.branch}\n")
    commit_ref = self.write_next_mark()
    self.write_changer("author", revision)
    self.write_changer("committer", revision)
    if revision.comment != "":
        self.output_data_string(f"{revision.comment}\n")
    else:
        if revision.edit_type == MoinEditType.PAGE:
            self.output_data_string(f"Add/Update {name}\n")
        elif revision.edit_type == MoinEditType.RENAME:
            self.output_data_string(f"Rename to {name}\n")
        elif revision.edit_type == MoinEditType.DELETE:
            self.output_data_string(f"Delete {name}\n")
        elif revision.edit_type == MoinEditType.ATTACH:
            self.output_data_string(f"Attach {revision.attachment} to {name}\n")
    # commit mark
    if self.last_commit_mark is not None:
        self.write_string(f"from :{self.last_commit_mark}\n")
    # data change
    if revision.edit_type == MoinEditType.PAGE:
        self.write_string(f"M 100644 :{blob_ref} {name}\n\n")
    elif revision.edit_type == MoinEditType.RENAME:
        self.write_string(
            f"D {revision.markdown_transform(revision.previous_page_name)}\n",
        )
        self.write_string(f"M 100644 :{blob_ref} {name}\n\n")
    elif revision.edit_type == MoinEditType.DELETE:
        self.write_string(f"D {name}\n\n")
    elif revision.edit_type == MoinEditType.ATTACH:
        self.write_string(
            f"M 100644 :{blob_ref} {revision.attachment_destination()}\n\n",
        )

    self.last_commit_mark = commit_ref
    self.ctx.logger.debug(f"Written commit {commit_ref}")

`end_stream(self)`

Write the end of stream information

Source code in moin2gitwiki/gitrevision.py

def end_stream(self):
    """
    Write the end of stream information
    """
    self.write_string(f"reset {self.branch}\n")
    self.write_string(f"from :{self.last_commit_mark}\n")

`get_next_mark(self)`

Increment and return the mark number

Source code in moin2gitwiki/gitrevision.py

def get_next_mark(self):
    """
    Increment and return the mark number
    """
    mark = self.mark_number
    self.mark_number += 1
    return mark

`output_blob(self, content)`

Output a blob object

Parameters:

Name	Type	Description	Default
`content`	`bytes`	The content of the blob, as bytes	required

Source code in moin2gitwiki/gitrevision.py

def output_blob(self, content: bytes):
    """
    Output a blob object

    Parameters:
        content:    The content of the blob, as bytes

    """
    self.output.write(b"blob\n")
    blob_ref = self.write_next_mark()
    self.output_data(content)
    return blob_ref

`output_data(self, content)`

Output a set of data bytes

Parameters:

Name	Type	Description	Default
`content`	`bytes`	The content of data, as bytes	required

Source code in moin2gitwiki/gitrevision.py

def output_data(self, content: bytes):
    """
    Output a set of data bytes

    Parameters:
        content:    The content of data, as bytes

    """
    self.write_string(f"data {len(content)}\n")
    self.output.write(content)

`output_data_string(self, string)`

Write a string out as a data object with utf-8 encoding into bytes

Source code in moin2gitwiki/gitrevision.py

def output_data_string(self, string: str):
    """
    Write a string out as a data object with utf-8 encoding into bytes
    """
    self.output_data(string.encode("utf-8"))

`write_changer(self, what, revision)`

Add an author/committer entry with date

Parameters:

Name	Type	Description	Default
`what`	`str`	Normally either `committer` or `author`	required
`revision`	`MoinEditEntry`	A wiki revision object	required

Source code in moin2gitwiki/gitrevision.py

def write_changer(self, what: str, revision: MoinEditEntry):
    """
    Add an author/committer entry with date

    Parameters:
        what:       Normally either `committer` or `author`
        revision:   A wiki revision object

    """
    self.write_string(
        f"{what} {revision.user.moin_name} <{revision.user.email}> {int(revision.edit_date.timestamp())} +0000\n",
    )

`write_next_mark(self)`

Write out the next mark number

Source code in moin2gitwiki/gitrevision.py

def write_next_mark(self):
    """
    Write out the next mark number
    """
    mark = self.get_next_mark()
    self.write_string(f"mark :{mark}\n")
    return mark

`write_string(self, string)`

Write a string out with utf-8 encoding into bytes

Source code in moin2gitwiki/gitrevision.py

def write_string(self, string: str):
    """
    Write a string out with utf-8 encoding into bytes
    """
    self.output.write(string.encode("utf-8"))