💡 [LIST command] LIST 명령어 해석 및 설계

[Yudongwoo]

🔑 How

• 아래 버전별로 list 명령어 해석한 내용 기록할 예정입니다.
  RFC 1459
  RFC 2812
  modern irc docs

• 내용을 분류해서 기본적인 것만 구현할 예정입니다.

  • 참고 : irssi, ergo server

• 조사할 사람 : dyu

✔ To-dos

• RFC 1459 기록하기
• RFC 2812 기록하기
• modern irc 기록하기
• 구현 사항 정리하고 이슈 발행하기
• 설계하기

📝 ETC

[Yudongwoo]

RFC 1459

• 메시지 형식

• LIST [채널 이름1],[채널 이름2],... [서버]
  • [서버] 파라미터만 생략할 수도 있음.
  • [채널 이름], [서버] 파라미터 모두 생략가능.
• Numeric reply
  • ERR_NOSUCHSERVER : 해당 서버가 존재하지 않을 때
  • RPL_LISTSTART : list 명령어가 시작되었다는 걸 알려주는 응답
  • RPL_LIST : list 실제 응답
  • RPL_LISTEND : list 명령어가 끝났다는 걸 알려주는 응답
  • 반환할 수 있는 채널이 없을 경우엔 RPL_LISTSTART, RPL_LISTEND만 응답(MUST)
• 내용
  • 채널과 해당 주제를 나열.
  • 채널 파라미터가 생략되면 개설된 채널 모두의 상태를 나열.
  • 채널 파라미터가 있으면 해당 채널 상태만 나열.
  • 클라이언트가 실제로 해당 채널에 존재 하지 않으면
    • private 채널은 주제 없이 'Prv'로 나열.
    • secret 채널은 전혀 나열되지 않음.
  • 예시

[Yudongwoo]

RFC 2812

• 메시지 형식

• LIST [채널 이름1],[채널 이름2],... [타겟 : 서버]
  • [서버] 파라미터만 생략할 수도 있음.
  • [채널 이름], [서버] 파라미터 모두 생략가능.
• Numeric reply
  • ERR_NOSUCHSERVER : 해당 서버가 존재하지 않을 때
  • RPL_TOOMANYMATCHES : 이게 어떤 응답인지 소개 안되어있음.
  • RPL_LIST : list 실제 응답
  • RPL_LISTEND : list 명령어가 끝났다는 걸 알려주는 응답
  • 반환할 수 있는 채널이 없을 경우엔 RPL_LISTEND만 응답(MUST)
• 내용
  • 채널과 해당 주제를 나열.
  • 채널 파라미터가 생략되면 개설된 채널 모두의 상태를 나열.
  • 채널 파라미터가 있으면 해당 채널 상태만 나열.
  • 서버 파라미터가 있으면 요청은 응답을 생성할 해당 서버로 전달.
  • 서버 파라미터에 와일드카드 허용.
• 예시

[Yudongwoo]

modern irc

• 메시지 형식

• LIST [채널 이름1],[채널 이름2],... [elistcond1],[elistcond2]
  • 파라미터 생략 가능.
• Numeric reply
  • RPL_LISTSTART
    • 채널 목록의 시작을 나타내는 응답.
    • 서버가 이 응답을 건너뛸 수도 있음(MAY)
    • 그래서 클라이언트는 이 응답을 받는 것에 의존하면 안됨.(MUST NOT)
  • RPL_LIST
    • LIST 명령어에 대한 응답.
    • 채널에 대한 정보를 클라이언트에 전송.
    • 채널에 대한 정보
      • 채널 이름
      • 클라이언트 수 : 해당 채널에 가입된 클라이언트 수
      • 주제 : 채널의 주제
  • RPL_LISTEND
    • LIST 명령어에 대한 응답의 끝을 나타냄.
• 내용
  • 각 채널에 대한 일부 정보와 함께 채널 목록을 나열.
  • 두 파라미터는 구문이 달라서 선택사항임.
  • 첫번째 파라미터
    • ','로 구분된 채널 이름 목록
    • 이 파라미터가 있으면 지정된 채널에 대한 정보만 나열.
    • 이 파라미터가 없으면 보이는 모든 채널에 대한 정보가 나열.
  • 두번째 파라미터
    • ','로 구분된 ELIST RPL_ISUPPORT 파라미터에 정의된 조건 목록
      • ELIST 파라미터
        • 서버가 LIST 명령에 대한 검색 확장을 지원함.
          • 예 : 채널 생성 시간을 기준으로 검색(C<20 : 20분 전에 생성된 채널만 검색)
        • 종류 : C, M, N, T, U 5가지
    • 서버가 ELIST 토큰으로 해당 조건에 대한 지원을 명시적으로 정의하지 않는 한
      클라이언트는 ELIST 조건을 제출해서는 안 됨.(MUST NOT)
    • 이 파라미터가 주어지면
      • 서버는 ELIST 문서에 지정된 대로 주어진 조건으로 리턴된 채널 목록을 필터링함.
  • 성공적인 LIST 명령에 대한 응답
    • 서버는 하나의 RPL_LISTSTART를 보낼 수 있음.(MAY)
    • 0개 이상의 RPL_LIST를 다시 보내야 함.(MUST)
    • 하나의 RPL_LISTEND를 다시 보내야 함.(MUST)

[Yudongwoo]

참고

• 상황

  • secret 채널 #ch1, public 채널 #ch2, #ch3가 있고,
  • 각 채널에는 클라이언트가 2, 3, 2명씩 있다고 가정.
  • 클라이언트가 ergo server에 접속하면 디폴트로 invisible 모드임.
  • 채널 주제는 #ch2만 설정되어있고 주제는 hello로 가정.

• ergo server & nc

  • secret 채널 내부에 있어도 해당 채널 출력 안됨.
  • 예시
    • secret 채널 #ch1에 nickname이 a인 클라이언트가 있을 때
    • a가 list 메시지를 파라미터 없이 보내든, #ch1을 타게팅해서 보내든
      • public 채널의 정보만 출력
        • 채널 이름, 클라이언트 수, 주제(없으면 : + 비워둠)
        • ...(생략) a #ch2 3 hello
        • ...(생략) a #ch3 2 :
        • RPL_LISTEND로 마무리
      • #ch1을 타게팅해서 보낼때는 ERR_NOSUCHCHANNEL 응답.
  • 클라이언트가 invisible 한지 여부 상관없이 클라이언트 수에 반영됨.
  • 파라미터로 들어온 채널이 유효하지 않을 때 파라미터 없는 경우로 처리.
    • 예시
      • LIST ajgil323
      • LIST로 처리되어 볼 수 있는 모든 채널 정보를 출력함.
      • #ch2, #ch3 정보가 출력되고 RPL_LISTEND로 마무리됨.
  • 클라이언트가 채널 이름을 ','로 구분해서 여러개 보낼 수 있지만
    맨 처음 채널 정보만 출력함.
  • 예시
    • LIST #ch2,#ch3
    • #ch2의 정보만 출력하고 RPL_LISTEND로 마무리 함.

• ergo server & irssi

  • ergo server & nc의 경우와 대체로 같지만 차이점은 아래와 같음.
    • 채널 내에서 LIST 명령어 보냈을 때 아무런 반응이 없음.
    • 파라미터 있든 없든 상관없이 무시됨.

[Yudongwoo]

구현 사항

• 메시지 형식

  • LIST [채널 이름1],[채널 이름2],... 로 선택
  • 이유
    • 두 번째 파라미터가 없어도 LIST 명령어의 기본 역할은 충분함.
    • RFC 1459, RFC 2812의 경우는 다중 서버일 때 의미가 있음.
    • modern irc는 부가적인 기능임.

• Numeric reply

  • RPL_LIST와 RPL_LISTEND만 사용.
  • 이유
    • RPL_LISTSTART
      • LIST 명령어 응답이 시작되었다는 걸 알려주기 위함인데
        RPL_LIST가 바로 나와도 LIST 명령어 응답이 시작되었다는 걸 알 수 있어서
        별 필요 없다고 생각함.
      • modern irc에서도 클라이언트가 RPL_LISTSTART 응답에 의존하면 안된다고 나와 있음.(MUST NOT)
    • RPL_TOOMANYMATCHES : 설명 자체가 안 나와있어서 무시함.
    • ERR_NOSUCHSERVER : 다중 서버일 때 의미가 있어서 필요없음.
    • RPL_LIST
      • 채널 이름, 클라이언트 수, 채널 주제를 출력.
      • private 채널은 "Prv"로 채널 이름 대체하며 채널 주제는 있어도 출력 안 함.
      • secret 채널은 아예 출력하지 않음.
      • 단 보이지 않는 채널에 가입되어 있으면 일반 채널처럼 정보를 출력함.

• 클라이언트의 visible여부에 관계없이 클라이언트 수에 반영할 예정.

  • 이유
    • LIST 명령어는 채널의 정보를 나열해주는 역할을 함.
    • 클라이언트가 invisible 한 상태에 있다는 건
      클라이언트를 직접적인 대상으로 하는 명령어에
      영향을 받지 않는다는 의미로 해석됨.
    • 문서내의 LIST 명령어에는 invisible 클라이언트에 대한 언급이 없음.

• 채널 상태는 클라이언트가 채널에 가입되어 있지 않을 때는 따로 구분하지 않음.

  • 이유
    • secret은 아예 나열되지 않고,
    • private은 "Prv"라는 이름으로 출력할 예정.
    • public은 채널 이름을 그대로 출력할 것이라서
    • 굳이 "=", "@", "*"로 구분할 필요 없다고 생각함.
    • 단 클라이언트가 채널에 가입되어 있을 때는
      일반 채널처럼 채널 정보를 출력할 것이기 때문에
      "=", "@", "*"로 구분할 예정.

• LIST 파라미터 없을 시

  • 현재 개설되어 있는 채널 순회
    • 가입되어 있거나 가입 안되어있지만 public 채널일 때
      • 채널 상태를 채널 이름 앞에 붙임.
      • 클라이언트 수 체크
      • 주제 있으면 주제 출력.
      • 주제 없으면 비워둠.
      • RPL_LISTEND.
    • 가입 안되어있을 때
      • private 채널이면
        • 채널 이름 : "Prv"
        • 클라이언트 수 체크
        • 주제는 무조건 비워둠.
        • RPL_LISTEND.
      • secret 채널이면 무시.

• LIST 파라미터 있을 시

  • 파라미터로 들어온 채널 이름을 ','로 분리해서 컨테이너에 저장.
  • 저장된 채널 이름 순회
    • 가입되어 있거나 가입 안되어있지만 public 채널일 때
      • 채널 상태를 채널 이름 앞에 붙임.
      • 클라이언트 수 체크
      • 주제 있으면 주제 출력.
      • 주제 없으면 비워둠.
      • RPL_LISTEND.
    • 가입 안되어있을 때
      • private 채널이면
        • 채널 이름 : "Prv"
        • 클라이언트 수 체크
        • 주제는 무조건 비워둠.
        • RPL_LISTEND.
      • secret 채널이면 무시.

• 중복되는 경우 함수로 묶을 예정.

[Yudongwoo]

💡 [LIST command] LIST 명령어 구현 시작 세팅하기

[Yudongwoo]

💡 [LIST command] LIST 명령어 구현하기