View GitHub Repository syslog2irc

Schedule Inspection
Subscribe

syslog2irc.formatting.format_message()   A
last analyzed

↳ Parent: syslog2irc.formatting

Complexity

Conditions 1

Size

Total Lines 22
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 9
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 11
nop 2
dl 0
loc 22
ccs 9
cts 9
cp 1
crap 1
rs 9.85
c 0
b 0
f 0
1 
"""
2 
syslog2irc.formatting
3 
~~~~~~~~~~~~~~~~~~~~~
4 

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    5
                

                                    
                                                    
                
                
                
Message formatting

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    6
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    7
                

                                    
                                                    
                
                
                
:Copyright: 2007-2021 Jochen Kupperschmidt

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    8
                

                                    
                                                    
                
                
                
:License: MIT, see LICENSE for details.

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    9
                

                                    
                                                    
                
                
                
"""

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    10
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    11
                

                                    
                             1                         
                
                
                
from __future__ import annotations

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    12
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    13
                

                                    
                             1                         
                
                
                
from syslogmp import Message as SyslogMessage

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    14
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    15
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    16
                

                                    
                             1                         
                
                
                
MESSAGE_TEXT_ENCODING = 'utf-8'

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    17
                

                                    
                                                    
                
                
                

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    18
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    19
                

                                    
                             1                         
                
                
                
def format_message(

            


            
                                                                        
                            
            
                                    
            
            

                
                    20
                

                                    
                                                    
                
                
                
    source_address: tuple[str, int], message: SyslogMessage

            


            
                                                                        
                            
            
                                    
            
            

                
                    21
                

                                    
                                                    
                
                
                
) -> str:

            


            
                                                                        
                            
            
                                    
            
            

                
                    22
                

                                    
                                                    
                
                
                
    """Format syslog message to be displayed on IRC."""

            


            
                                                                        
                            
            
                                    
            
            

                
                    23
                

                                    
                             1                         
                
                
                
    source_host = source_address[0]

            


            
                                                                        
                            
            
                                    
            
            

                
                    24
                

                                    
                             1                         
                
                
                
    source_port = source_address[1]

            


            
                                                                        
                            
            
                                    
            
            

                
                    25
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    26
                

                                    
                             1                         
                
                
                
    timestamp_format = '%Y-%m-%d %H:%M:%S'

            


            
                                                                        
                            
            
                                    
            
            

                
                    27
                

                                    
                             1                         
                
                
                
    formatted_timestamp = message.timestamp.strftime(timestamp_format)

            


            
                                                                        
                            
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    29
                

                                    
                             1                         
                
                
                
    severity_name = message.severity.name

            


            
                                                                        
                            
            
                                    
            
            

                
                    30
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    31
                

                                    
                                                    
                
                
                
    # Important: The message text is a byte string.

            


            
                                                                        
                            
            
                                    
            
            

                
                    32
                

                                    
                             1                         
                
                
                
    text = message.message.decode(MESSAGE_TEXT_ENCODING)

            


            
                                                                        
                            
            
                                    
            
            

                
                    33
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    34
                

                                    
                                                    
                
                
                
    # Remove leading and trailing newlines. Those would result in

            


            
                                                                        
                            
            
                                    
            
            

                
                    35
                

                                    
                                                    
                
                
                
    # additional lines on IRC with the usual metadata but with an

            


            
                                                                        
                            
            
                                    
            
            

                
                    36
                

                                    
                                                    
                
                
                
    # empty message text.

            


            
                                                                        
                            
            
                                    
            
            

                
                    37
                

                                    
                             1                         
                
                
                
    text = text.strip('\n')

            


            
                                                                        
                            
            
                                    
            
            

                
                    38
                

                                    
                                                    
                
                
                

            


            
                                                                        
                            
            
                                    
            
            

                
                    39
                

                                    
                             1                         
                
                
                
    return (

            


            
                                                                        
                            
            
                                    
            
            

                
                    40
                

                                    
                                                    
                
                
                
        f'{source_host}:{source_port:d} '

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    41
                

                                    
                                                    
                
                
                
        f'[{formatted_timestamp}] '

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    42
                

                                    
                                                    
                
                
                
        f'({message.hostname}) '

            


            
                                                                                                            
                            
            
                                    
            
            

                
                    43
                

                                    
                                                    
                
                
                
        f'[{severity_name}]: {text}'

            


            
                                                                                                            
                                                                
            
                                    
            
            

                
                    44
                

                                    
                                                    
                
                
                
    )

            


            
                                                        
            
                                    
            
            

                
                    45